Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_TimerTask.h
index c17ae5b..18c192b 100644 (file)
@@ -1,7 +1,4 @@
-/**
- * $Id$
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
+/*
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
- * Contributor(s): none yet.
- *
- * ***** END GPL LICENSE BLOCK *****
  */
-/**
- * @file       GHOST_TimerTask.h
+
+/** \file \ingroup GHOST
  * Declaration of GHOST_TimerTask class.
  */
 
-#ifndef _GHOST_TIMER_TASK_H_
-#define _GHOST_TIMER_TASK_H_
+#ifndef __GHOST_TIMERTASK_H__
+#define __GHOST_TIMERTASK_H__
 
 #include "GHOST_ITimerTask.h"
 
 
 /**
  * Implementation of a timer task.
- * @author     Maarten Gribnau
- * @date       May 28, 2001
  */
 class GHOST_TimerTask : public GHOST_ITimerTask
 {
 public:
        /**
         * Constructor.
-        * @param start         The timer start time.
-        * @param interval      The interval between calls to the timerProc
-        * @param timerProc     The callbak invoked when the interval expires.
-        * @param data          The timer user data.
+        * \param start         The timer start time.
+        * \param interval      The interval between calls to the timerProc
+        * \param timerProc     The callback invoked when the interval expires.
+        * \param userData: The timer user data.
         */
-       GHOST_TimerTask(GHOST_TUns64 start, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = 0)
-               : m_start(start), m_interval(interval), m_next(start), m_timerProc(timerProc), m_userData(userData), m_auxData(0)
+       GHOST_TimerTask(GHOST_TUns64 start,
+                       GHOST_TUns64 interval,
+                       GHOST_TimerProcPtr timerProc,
+                       GHOST_TUserDataPtr userData = NULL)
+               : m_start(start),
+               m_interval(interval),
+               m_next(start),
+               m_timerProc(timerProc),
+               m_userData(userData),
+               m_auxData(0)
        {
        }
 
        /**
         * Returns the timer start time.
-        * @return The timer start time.
+        * \return The timer start time.
         */
-       inline virtual GHOST_TUns64 getStart() const
+       inline GHOST_TUns64 getStart() const
        {
                return m_start;
        }
 
        /**
         * Changes the timer start time.
-        * @param start The timer start time.
+        * \param start The timer start time.
         */
-       virtual void setStart(GHOST_TUns64 start)
-       { 
+       void setStart(GHOST_TUns64 start)
+       {
                m_start = start;
        }
 
        /**
         * Returns the timer interval.
-        * @return The timer interval.
+        * \return The timer interval.
         */
-       inline virtual GHOST_TUns64 getInterval() const
+       inline GHOST_TUns64 getInterval() const
        {
                return m_interval;
        }
 
        /**
         * Changes the timer interval.
-        * @param interval The timer interval.
+        * \param interval The timer interval.
         */
-       virtual void setInterval(GHOST_TUns64 interval)
-       { 
+       void setInterval(GHOST_TUns64 interval)
+       {
                m_interval = interval;
        }
 
        /**
         * Returns the time the timerProc will be called.
-        * @return The time the timerProc will be called.
+        * \return The time the timerProc will be called.
         */
-       inline virtual GHOST_TUns64 getNext() const
+       inline GHOST_TUns64 getNext() const
        {
                return m_next;
        }
 
        /**
         * Changes the time the timerProc will be called.
-        * @param next The time the timerProc will be called.
+        * \param next The time the timerProc will be called.
         */
-       virtual void setNext(GHOST_TUns64 next)
-       { 
+       void setNext(GHOST_TUns64 next)
+       {
                m_next = next;
        }
 
        /**
         * Returns the timer callback.
-        * @return the timer callback.
+        * \return the timer callback.
         */
-       inline virtual GHOST_TimerProcPtr getTimerProc() const
+       inline GHOST_TimerProcPtr getTimerProc() const
        {
                return m_timerProc;
        }
 
        /**
         * Changes the timer callback.
-        * @param The timer callback.
+        * \param timerProc: The timer callback.
         */
-       inline virtual void setTimerProc(const GHOST_TimerProcPtr timerProc)
+       inline void setTimerProc(const GHOST_TimerProcPtr timerProc)
        {
                m_timerProc = timerProc;
        }
 
        /**
         * Returns the timer user data.
-        * @return The timer user data.
+        * \return The timer user data.
         */
-       inline virtual GHOST_TUserDataPtr getUserData() const
+       inline GHOST_TUserDataPtr getUserData() const
        {
                return m_userData;
        }
-       
+
        /**
         * Changes the time user data.
-        * @param data The timer user data.
+        * \param userData: The timer user data.
         */
-       virtual void setUserData(const GHOST_TUserDataPtr userData)
+       void setUserData(const GHOST_TUserDataPtr userData)
        {
                m_userData = userData;
        }
 
        /**
         * Returns the auxiliary storage room.
-        * @return The auxiliary storage room.
+        * \return The auxiliary storage room.
         */
-       inline virtual GHOST_TUns32 getAuxData() const
+       inline GHOST_TUns32 getAuxData() const
        {
                return m_auxData;
        }
 
        /**
         * Changes the auxiliary storage room.
-        * @param auxData The auxiliary storage room.
+        * \param auxData The auxiliary storage room.
         */
-       virtual void setAuxData(GHOST_TUns32 auxData)
-       { 
+       void setAuxData(GHOST_TUns32 auxData)
+       {
                m_auxData = auxData;
        }
 
@@ -184,5 +181,4 @@ protected:
        GHOST_TUns32 m_auxData;
 };
 
-#endif // _GHOST_TIMER_TASK_H_
-
+#endif // __GHOST_TIMERTASK_H__