More docs

flyingoctopus · Feb 6, 2012 · a293903 · a293903
1 parent 4a80aec
commit a293903
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/lib/kss/comment_parser.rb b/lib/kss/comment_parser.rb
@@ -6,7 +6,7 @@ module Kss
   # /* Multi-line style. */
   class CommentParser
 
-    # Is this a single-line comment? // This style
+    # Public: Is this a single-line comment? // This style
     #
     # line - A String of one line of text.
     #
@@ -15,7 +15,7 @@ def self.single_line_comment?(line)
       !!(line =~ /^\s*\/\//)
     end
 
-    # Is this the start of a multi-line comment? /* This style */
+    # Public: Is this the start of a multi-line comment? /* This style */
     #
     # line - A String of one line of text.
     #
@@ -24,7 +24,7 @@ def self.start_multi_line_comment?(line)
       !!(line =~ /^\s*\/\*/)
     end
 
-    # Is this the end of a multi-line comment? /* This style */
+    # Public: Is this the end of a multi-line comment? /* This style */
     #
     # line - A String of one line of text.
     #
@@ -34,7 +34,7 @@ def self.end_multi_line_comment?(line)
       !!(line =~ /.*\*\//)
     end
 
-    # Removes comment identifiers for single-line comments.
+    # Public: Removes comment identifiers for single-line comments.
     #
     # line - A String of one line of text.
     #
@@ -44,7 +44,7 @@ def self.parse_single_line(line)
       cleaned.rstrip
     end
 
-    # Remove comment identifiers for multi-line comments.
+    # Public: Remove comment identifiers for multi-line comments.
     #
     # line - A String of one line of text.
     #
@@ -81,6 +81,9 @@ def blocks
     end
 
 
+    # Parse the file for comment blocks and populate them into @blocks.
+    #
+    # Returns an Array  of parsed comment Strings.
     def parse_blocks
       File.open @file_path do |file|
         current_block = nil