Changeset 7375 for code/branches/doc/src/libraries/tools/Timer.cc

Timestamp:

Sep 8, 2010, 1:39:02 AM (14 years ago)

Author:

landauf

Message:

added documentation

File:

• code/branches/doc/src/libraries/tools/Timer.cc (modified) (6 diffs)

code/branches/doc/src/libraries/tools/Timer.cc

@@ -27 +27 @@
  */
 
+/**
+    @file
+    @brief Implementation of the Timer class.
+*/
+
 #include "Timer.h"
 
@@ -45 +50 @@
 
     /**
-        @brief Calls a console command after 'delay' seconds.
+        @brief Console-command: Calls another console command after @a delay seconds.
         @param delay The delay in seconds
         @param command The console command
@@ -60 +65 @@
 
     /**
-        @brief Executes the command.
-        @param timer The timer to destroy after the command-execution
+        @brief Helper function for delay(), executes the command and destroys the timer.
+        @param timer The timer which called this function.
         @param command The command to execute
     */
@@ -72 +77 @@
 
     /**
-        @brief Kills all delayed commands.
+        @brief Console-command: Kills all scheduled commands that were delayed using delay().
     */
     void killdelays()
@@ -92 +97 @@
 
     /**
-        @brief Constructor: Initializes the Timer with given values.
-        @param interval The timer-interval in seconds
-        @param bLoop If true, the function gets called every 'interval' seconds
-        @param executor A executor of the function to call
-        @param bKillAfterCall If true, the timer will be deleted after the function was executed
+        @brief Constructor: Initializes and starts the timer, which will call an executor after some time.
+        @param interval         The timer-interval in seconds
+        @param bLoop            If true, the executor gets called every @a interval seconds
+        @param executor         The executor that will be called
+        @param bKillAfterCall   If true, the timer will be deleted after the executor was called
     */
     Timer::Timer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall)
@@ -121 +126 @@
 
     /**
-        @brief Executes the executor.
+        @brief Calls the executor and destroys the timer if requested.
     */
     void Timer::run()