From: Matthias Braun <matze@braunis.de>
Date: Tue, 23 Nov 2004 22:51:03 +0000 (+0000)
Subject: docu improvement for Timer
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=0c3137495e5ce06110dbd2931b4557548506bde4;p=supertux.git

docu improvement for Timer

SVN-Revision: 2162
---

diff --git a/src/timer.h b/src/timer.h
index a0e49e060..4640e575b 100644
--- a/src/timer.h
+++ b/src/timer.h
@@ -12,12 +12,14 @@ public:
   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 */