lib/coco/cover/coverage_result.rb in coco-0.8 vs lib/coco/cover/coverage_result.rb in coco-0.9

@@ -1,19 +1,26 @@
 # -*- encoding: utf-8 -*-
 
 module Coco
 
-  # Compute results of interest from the big results information (from Coverage.result)
+  # Compute results of interest from the big results information (from
+  # Coverage.result)
   class CoverageResult
-    # @return [Hash] Coverage for all the sources that live in the root project folder.
+
+    # Returns a Hash coverage for all the sources that live in the root
+    # project folder.
     attr_reader :all_from_domain
-    # @return [Hash] Coverage for sources that are not sufficiently covered.
-    #   More technically, the sources that live in the root project folder and for
-    #   which the coverage percentage is under the threshold. 
+
+    # Returns a Hash coverage for sources that are not sufficiently
+    # covered. More technically, the sources that live in the root
+    # project folder and for which the coverage percentage is under the
+    # threshold. 
     attr_reader :covered_from_domain
   
-    # @param [Hash] config
-    # @param [Hash] raw_results Results obtained from Coverage.result
+    # Public: Initialize a CoverageResult.
+    #
+    # config      - Hash
+    # raw_results - Hash results obtained from Coverage.result.
     def initialize config, raw_results
       @exclude_files = config[:excludes]
       @threshold = config[:threshold]
       raise ArgumentError if @threshold < 0
       @result = raw_results