diff options
Diffstat (limited to 'intern/ghost/intern/GHOST_TimerManager.h')
-rw-r--r-- | intern/ghost/intern/GHOST_TimerManager.h | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/intern/ghost/intern/GHOST_TimerManager.h b/intern/ghost/intern/GHOST_TimerManager.h index 88d27088c1d..5a24c56ef10 100644 --- a/intern/ghost/intern/GHOST_TimerManager.h +++ b/intern/ghost/intern/GHOST_TimerManager.h @@ -44,8 +44,8 @@ class GHOST_TimerTask; * Manages a list of timer tasks. * Timer tasks added are owned by the manager. * Don't delete timer task objects. - * @author Maarten Gribnau - * @date May 31, 2001 + * \author Maarten Gribnau + * \date May 31, 2001 */ class GHOST_TimerManager { @@ -62,51 +62,51 @@ public: /** * Returns the number of timer tasks. - * @return The number of events on the stack. + * \return The number of events on the stack. */ virtual GHOST_TUns32 getNumTimers(); /** * Returns whther this timer task ins in our list. - * @return Indication of presence. + * \return Indication of presence. */ virtual bool getTimerFound(GHOST_TimerTask *timer); /** * Adds a timer task to the list. * It is only added when it not already present in the list. - * @param timer The timer task added to the list. - * @return Indication as to whether addition has succeeded. + * \param timer The timer task added to the list. + * \return Indication as to whether addition has succeeded. */ virtual GHOST_TSuccess addTimer(GHOST_TimerTask *timer); /** * Removes a timer task from the list. * It is only removed when it is found in the list. - * @param timer The timer task to be removed from the list. - * @return Indication as to whether removal has succeeded. + * \param timer The timer task to be removed from the list. + * \return Indication as to whether removal has succeeded. */ virtual GHOST_TSuccess removeTimer(GHOST_TimerTask *timer); /** * Finds the soonest time the next timer would fire. - * @return The soonest time the next timer would fire, + * \return The soonest time the next timer would fire, * or GHOST_kFireTimeNever if no timers exist. */ virtual GHOST_TUns64 nextFireTime(); /** * Checks all timer tasks to see if they are expired and fires them if needed. - * @param time The current time. - * @return True if any timers were fired. + * \param time The current time. + * \return True if any timers were fired. */ virtual bool fireTimers(GHOST_TUns64 time); /** * Checks this timer task to see if they are expired and fires them if needed. - * @param time The current time. - * @param task The timer task to check and optionally fire. - * @return True if the timer fired. + * \param time The current time. + * \param task The timer task to check and optionally fire. + * \return True if the timer fired. */ virtual bool fireTimer(GHOST_TUns64 time, GHOST_TimerTask *task); |