lib/monte_carlo/result.rb in monte_carlo-0.0.5 vs lib/monte_carlo/result.rb in monte_carlo-0.0.6

@@ -1,8 +1,15 @@
 module MonteCarlo
+  # Class that contains the result of a single sample of a {MonteCarlo::Experiment}
   class Result
     include Comparable
 
+    # @!attribute value
+    #   @return the value returned after the computation
+    # @!attribute sample_value
+    #   @return the raw value returned from the sample method
+    # @!attribute index
+    #   @return [Fixnum] the index of the iteration the result was generated at
     attr_accessor :value, :sample_value, :index
 
     def initialize(index = nil, value = nil, sample_value = nil)
       @value = value
       @sample_value = sample_value