lib/backburner/performable.rb in backburner-0.0.1 vs lib/backburner/performable.rb in backburner-0.0.2

@@ -9,25 +9,29 @@
     end
 
     module InstanceMethods
       # Return proxy object to enqueue jobs for object
       # Options: `pri` (priority), `delay` (delay in secs), `ttr` (time to respond), `queue` (queue name)
-      # @model.async(:pri => 1000).do_something("foo")
+      # @example
+      #   @model.async(:pri => 1000).do_something("foo")
+      #
       def async(opts={})
         Backburner::AsyncProxy.new(self.class, self.id, opts)
       end
     end # InstanceMethods
 
     module ClassMethods
       # Return proxy object to enqueue jobs for object
       # Options: `pri` (priority), `delay` (delay in secs), `ttr` (time to respond), `queue` (queue name)
-      # Model.async(:ttr => 300).do_something("foo")
+      # @example
+      #   Model.async(:ttr => 300).do_something("foo")
       def async(opts={})
         Backburner::AsyncProxy.new(self, nil, opts)
       end
 
       # Defines perform method for job processing
-      # perform(55, :do_something, "foo", "bar")
+      # @example
+      #   perform(55, :do_something, "foo", "bar")
       def perform(id, method, *args)
         if id # instance
           find(id).send(method, *args)
         else # class method
           send(method, *args)