Changeset 7367 for code/branches/doc/src/libraries/util/Clock.h

Timestamp:

Sep 6, 2010, 3:51:29 PM (15 years ago)

Author:

rgrieder

Message:

Added Doxygen documentation for ExprParser, MathConvert, OrxEnum, OrxAssert and TriBool.
Adjusted Doxygen documentation for Clock and Exception.

File:

• code/branches/doc/src/libraries/util/Clock.h (modified) (2 diffs)

code/branches/doc/src/libraries/util/Clock.h

@@ -41 +41 @@
         via Clock& references (for instance for the game tick). <br>
         Precision: <br>
+    @par Precision
         The maximum precision is given by the Ogre::Timer and that is somewhere
         in the microsecond range for both Windows and UNIX. 
-    @remarks
+    @par Remarks for Usage on Windows
         For proper functionality this class MUST be used in the same thread! <br>
-        Further more it might be possible that the Ogre::Timer has a performance
-        caveat on Windows because it will only capture the time on the same
-        CPU core. Confining the main thread to one process could speed up the game.
-        See command line argument 'limitToCPU'.
+        Furthermore it might be possible that the Ogre::Timer has a performance
+        caveat because it will only capture the time on the same CPU core.
+        Confining the main thread to one process could speed up the game.
+        See \ref cmdargspage "Ccommandline Argument" 'limitToCPU' (only on Windows)
     */
     class _UtilExport Clock
     {
     public:
-        //! Starts the time at 0
+        /// Starts the time at 0
         Clock();
         ~Clock();
 
-        //! Internally captures the time and stays at that particular time
+        /** Internally captures the time and stays at that particular time
+        @remarks
+            Mind the types! Ogre::Timer::getMicroseconds() will return an unsigned
+            long, which will eventually overflow. But if you use the subtraction of
+            the current time minus the last time the timer gave us and sum these up to
+            a 64 bit integer, we get the desired result. <br>
+            Also mind that we don't have to store the last timer's time as unsigned long
+            as well because (unsigned long)tickTime_ will do exactly that.
+        */
         void capture();
 
-        //! Returns the last captured absolute time in microseconds
+        /// Returns the last captured absolute time in microseconds
         unsigned long long getMicroseconds() const
             { return tickTime_; }
-        //! Returns the last captured absolute time in milliseconds
+        /// Returns the last captured absolute time in milliseconds
         unsigned long long getMilliseconds() const
             { return tickTime_ / 1000; }
-        //! Returns the last captured absolute time in seconds
+        /// Returns the last captured absolute time in seconds
         unsigned long getSeconds() const
             { return static_cast<long> (tickTime_ / 1000000); }
-        //! Returns the last captured absolute time in seconds as float
+        /// Returns the last captured absolute time in seconds as float
         float getSecondsPrecise() const
             { return static_cast<float>(tickTime_ / 1000000.0f); }
 
-        //! Returns the timespan in seconds between the last two calls to capture()
+        /// Returns the timespan in seconds between the last two calls to capture()
         float getDeltaTime() const
             { return tickDtFloat_; }
-        //! Returns the timespan in microseconds between the last two calls to capture()
+        /// Returns the timespan in microseconds between the last two calls to capture()
         long getDeltaTimeMicroseconds() const
             { return tickDt_; }
@@ -88 +97 @@
 
     private:
-        //! Undefined
+        /// Undefined
         Clock(const Clock& instance);
 
-        Ogre::Timer*       timer_;       //!< Ogre timer object
-        unsigned long long tickTime_;    //!< Currently captured time
-        long               tickDt_;      //!< Delta time in microseconds (cache value)
-        float              tickDtFloat_; //!< Delta time in seconds (cache value)
+        Ogre::Timer*       timer_;       ///< Ogre timer object
+        unsigned long long tickTime_;    ///< Currently captured time
+        long               tickDt_;      ///< Delta time in microseconds (cache value)
+        float              tickDtFloat_; ///< Delta time in seconds (cache value)
     };
 }