[Super-tux-commit] supertux/src timer.h,1.18,1.19

[Matze B. <mat...@us...>]

Update of /cvsroot/super-tux/supertux/src
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv20431/src

Modified Files:
	timer.h 
Log Message:
docu improvement for Timer

Index: timer.h
===================================================================
RCS file: /cvsroot/super-tux/supertux/src/timer.h,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19
--- timer.h	23 Nov 2004 22:22:14 -0000	1.18
+++ timer.h	23 Nov 2004 22:51:03 -0000	1.19
@@ -12,12 +12,14 @@
   Timer2();
   ~Timer2();
 
-  /** start the timer with the given period. If cyclic=true then the timer willl
-   * be reset after each period.
+  /** start the timer with the given period (in seconds).
+   * If cyclic=true then the timer willl be reset after each period.
    * Set period to zero if you want to disable the timer.
    */
   void start(float period, bool cyclic = false);
-  /** returns true if a period (or more) passed */
+  /** returns true if a period (or more) passed since start call or last
+   * successfull check
+   */
   bool check();
 
   /** returns the period of the timer or 0 if it isn't started */