lib/ripple/timestamps.rb in ripple-0.8.0.beta2 vs lib/ripple/timestamps.rb in ripple-0.8.0

@@ -12,21 +12,26 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 require 'ripple'
 
 module Ripple
+  # Adds automatic creation and update timestamps to a
+  # {Ripple::Document} model.
   module Timestamps
     extend ActiveSupport::Concern
 
     module ClassMethods
+      # Adds the :created_at and :updated_at timestamp properties to
+      # the document.
       def timestamps!
         property :created_at, Time, :default => proc { Time.now.utc }
         property :updated_at, Time
         before_save :touch
       end
     end
 
     module InstanceMethods
+      # Sets the :updated_at attribute before saving the document.
       def touch
         self.updated_at = Time.now.utc
       end
     end
   end