Added descriptions to the Fuzzing classes.

ronin-rb · Jun 10, 2012 · 3b28785 · 3b28785
1 parent 410bb03
commit 3b28785
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/lib/ronin/fuzzing/fuzzer.rb b/lib/ronin/fuzzing/fuzzer.rb
@@ -24,6 +24,9 @@
 
 module Ronin
   module Fuzzing
+    #
+    # Fuzzing class that incrementally fuzzes a String, given substitution
+    # rules.
     #
     # @api semipublic
     #

diff --git a/lib/ronin/fuzzing/mutator.rb b/lib/ronin/fuzzing/mutator.rb
@@ -28,6 +28,9 @@
 
 module Ronin
   module Fuzzing
+    #
+    # Fuzzer class that permutates over every mutation of a String, given
+    # mutation rules.
     #
     # @api semipublic
     #

diff --git a/lib/ronin/fuzzing/repeater.rb b/lib/ronin/fuzzing/repeater.rb
@@ -19,6 +19,8 @@
 
 module Ronin
   module Fuzzing
+    #
+    # Fuzzing class that generates repeated data.
     #
     # @api semipublic
     #

diff --git a/lib/ronin/fuzzing/template.rb b/lib/ronin/fuzzing/template.rb
@@ -23,6 +23,8 @@
 
 module Ronin
   module Fuzzing
+    #
+    # Fuzzing class that generates Strings based on a template.
     #
     # @api semipublic
     #