lib/coco/formatter/context.rb in coco-0.10.0 vs lib/coco/formatter/context.rb in coco-0.11.0

@@ -1,33 +1,55 @@
 # -*- encoding: utf-8 -*-
 
 module Coco
-  
+
   # Contextual information for ERB template, representing each covered files.
   class Context
-  
+
+    # Public: Initialize a Context for a covered file shown in the HTML
+    # report.
+    #
     # filename - A String name of the source file.
     # lines    - An Array of lines.
-		def initialize filename, lines
+		def initialize(filename, lines)
 			@filename = filename
       @lines = lines
 		end
 		
+    # Public: Get the object's binding.
+    #
+    # Returns Binding.
 		def get_binding
 			binding
 		end
 	end
-  
+
   # Contextual information for ERB template, representing index.html.
   class IndexContext
-  
-    # @todo doc, inheritance (with Context)
-		def initialize title, covered, uncovered
+
+    # Public: Initialize an IndexContext for the index file in the HTML
+    # report.
+    #
+    # title     - The String title for the report.
+    # covered   - Array of subarrays. Each subarray is:
+    #             [
+    #               Fixnum coverage percentage,
+    #               String formatted filename (HTML ready),
+    #               String real filename
+    #             ]
+    #             FIXME Need a class to handle subarrays.
+    # uncovered - Array of String filenames. The filenames are already
+    #             formatted, ready to be display in an HTML file.
+    #
+		def initialize(title, covered, uncovered)
 			@title = title
       @covered = covered
       @uncovered = uncovered
 		end
 		
+    # Public: Get the object's binding.
+    #
+    # Returns Binding.
 		def get_binding
 			binding
 		end
 	end