fixed typo in help auth

[user/henk/code/ruby/rbot.git] / lib / rbot / timer.rb

diff --git a/lib/rbot/timer.rb b/lib/rbot/timer.rb
index 10a6f318e919bdb976a084d680681adcfc819269..8adb14d8d42f955480c22402ec48f478e1b4468f 100644 (file)
--- a/lib/rbot/timer.rb
+++ b/lib/rbot/timer.rb
@@ -26,19 +26,19 @@ class Timer
     # Time when the Action should be called next
     attr_accessor :next
 
-    # options are:
-    #   start::    Time when the Action should be run for the first time.
-    #               Repeatable Actions will be repeated after that, see
-    #               :period. One-time Actions will not (obviously)
-    #               Default: Time.now + :period
-    #   period::   How often repeatable Action should be run, in seconds.
-    #               Default: 1
-    #   blocked::  if true, Action starts as blocked (i.e. will stay dormant
-    #               until unblocked)
-    #   args::     Arguments to pass to the Action callback. Default: []
-    #   repeat::   Should the Action be called repeatedly? Default: false
-    #   code::     You can specify the Action body using &block, *or* using
-    #               this option.
+    # Options are:
+    # start::    Time when the Action should be run for the first time.
+    #            Repeatable Actions will be repeated after that, see
+    #            :period. One-time Actions will not (obviously)
+    #            Default: Time.now + :period
+    # period::   How often repeatable Action should be run, in seconds.
+    #            Default: 1
+    # blocked::  if true, Action starts as blocked (i.e. will stay dormant
+    #            until unblocked)
+    # args::     Arguments to pass to the Action callback. Default: []
+    # repeat::   Should the Action be called repeatedly? Default: false
+    # code::     You can specify the Action body using &block, *or* using
+    #            this option.
 
     def initialize(options = {}, &block)
       opts = {
@@ -129,11 +129,12 @@ class Timer
     self.start
   end
 
-  # creates and installs a new Action, repeatable by default.
-  #    period:: Action period
-  #    opts::   options for Action#new, see there
-  #    block::  Action callback code
-  # returns the id of the created Action
+  # Creates and installs a new Action, repeatable by default.
+  # _period_:: Action period
+  # _opts_::   options for Action#new, see there
+  # _block_::  Action callback code
+  #
+  # Returns the id of the created Action
   def add(period, opts = {}, &block)
     a = Action.new({:repeat => true, :period => period}.merge(opts), &block)
     self.synchronize do
@@ -143,24 +144,25 @@ class Timer
     return a.object_id
   end
 
-  # creates and installs a new Action, one-time by default.
-  #    period:: Action delay
-  #    opts::   options for Action#new, see there
-  #    block::  Action callback code
-  # returns the id of the created Action
+  # Creates and installs a new Action, one-time by default.
+  # _period_:: Action delay
+  # _opts_::   options for Action#new, see there
+  # _block_::  Action callback code
+  #
+  # Returns the id of the created Action
   def add_once(period, opts = {}, &block)
     self.add(period, {:repeat => false}.merge(opts), &block)
   end
 
   # blocks an existing Action
-  #    aid:: Action id, obtained previously from add() or add_once()
+  # _aid_:: Action id, obtained previously from add() or add_once()
   def block(aid)
     debug "blocking #{aid}"
     self.synchronize { self[aid].block }
   end
 
   # unblocks an existing blocked Action
-  #    aid:: Action id, obtained previously from add() or add_once()
+  # _aid_:: Action id, obtained previously from add() or add_once()
   def unblock(aid)
     debug "unblocking #{aid}"
     self.synchronize do
@@ -170,7 +172,7 @@ class Timer
   end
 
   # removes an existing blocked Action
-  #    aid:: Action id, obtained previously from add() or add_once()
+  # _aid_:: Action id, obtained previously from add() or add_once()
   def remove(aid)
     self.synchronize do
       @actions.delete(aid) # or raise "nonexistent action #{aid}"
@@ -180,9 +182,9 @@ class Timer
   alias :delete :remove
 
   # Provides for on-the-fly reconfiguration of Actions
-  #    aid::   Action id, obtained previously from add() or add_once()
-  #    opts::  see Action#new
-  #   block:: (optional) new Action callback code
+  # _aid_::   Action id, obtained previously from add() or add_once()
+  # _opts_::  see Action#new
+  # _block_:: (optional) new Action callback code
   def configure(aid, opts = {}, &block)
     self.synchronize do
       self[aid].configure(opts, &block)
@@ -191,9 +193,9 @@ class Timer
   end
 
   # changes Action period
-  #   aid:: Action id
-  #   period:: new period
-  #   block:: (optional) new Action callback code
+  # _aid_:: Action id
+  # _period_:: new period
+  # _block_:: (optional) new Action callback code
   def reschedule(aid, period, &block)
     self.configure(aid, :period => period, &block)
   end
@@ -244,7 +246,7 @@ class Timer
         ensure
           @current = nil
         end
-          
+
         unless v
           @actions.delete k
           next