Documentation comments

Author: avit

lib/ice_cube/validations/count.rb

@@ -2,7 +2,7 @@ module IceCube
 
   module Validations::Count
 
-    # accessor
+    # Value reader for limit
     def occurrence_count
       @count
     end

lib/ice_cube/validations/daily_interval.rb

@@ -10,8 +10,6 @@ def interval(interval)
       self
     end
 
-    # A validation for checking to make sure that a time
-    # is inside of a certain DailyInterval
     class Validation
 
       attr_reader :interval

lib/ice_cube/validations/lock.rb

@@ -1,8 +1,13 @@
 module IceCube
 
-  # A validation mixin that will lock the +type field to
-  # +value or +schedule.start_time.send(type) if value is nil
-
+  # This validation mixin is used by the various "fixed-time" (e.g. day,
+  # day_of_month, hour_of_day) Validation and ScheduleLock::Validation modules.
+  # It is not a standalone rule validation like the others.
+  #
+  # Given the including Validation's defined +type+ field, it will lock
+  # to the specified +value+ or else the corresponding time unit from the
+  # schedule's start_time
+  #
   module Validations::Lock
 
     INTERVALS = {:min => 60, :sec => 60, :hour => 24, :month => 12, :wday => 7}

lib/ice_cube/validations/schedule_lock.rb

@@ -2,16 +2,16 @@ module IceCube
 
   module Validations::ScheduleLock
 
-    # Lock the given times down the schedule's start_time for that position
+    # Lock the given time units to the units from schedule's +start_time+
     # These locks are all clobberable by other rules of the same #type
-    # using clobber_base_validation
+    # using +clobber_base_validation+
+    #
     def schedule_lock(*types)
       types.each do |type|
         validations_for(:"base_#{type}") << Validation.new(type)
       end
     end
 
-    # A validation used for locking time into a certain value
     class Validation
 
       include Validations::Lock

lib/ice_cube/validations/until.rb

@@ -4,7 +4,7 @@ module Validations::Until
 
     extend Deprecated
 
-    # accessor
+    # Value reader for limit
     def until_time
       @until
     end