From 0c3137495e5ce06110dbd2931b4557548506bde4 Mon Sep 17 00:00:00 2001 From: Matthias Braun Date: Tue, 23 Nov 2004 22:51:03 +0000 Subject: [PATCH] docu improvement for Timer SVN-Revision: 2162 --- src/timer.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) 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 */ -- 2.11.0