[Pingus-CVS] r3332 - trunk/pingus/src

[plouj at BerliOS]

Author: plouj
Date: 2007-10-27 05:55:17 +0200 (Sat, 27 Oct 2007)
New Revision: 3332

Modified:
   trunk/pingus/src/delta_manager.hpp
Log:
added some documentation


Modified: trunk/pingus/src/delta_manager.hpp
===================================================================
--- trunk/pingus/src/delta_manager.hpp  2007-10-27 03:34:34 UTC (rev 3331)
+++ trunk/pingus/src/delta_manager.hpp  2007-10-27 03:55:17 UTC (rev 3332)
@@ -29,14 +29,17 @@
 class DeltaManager
 {
 private:
-  unsigned int absolute_time;
-  unsigned int last_time;
+  unsigned int absolute_time; ///< time in milliseconds since the start of 
DeltaManager
+  unsigned int last_time; ///< number of ticks when we were last set
 public:
   DeltaManager ()
     : absolute_time(0),
       last_time (SDL_GetTicks())
   {}
 
+  /** @brief get the current delta and start a new one
+   * @return the current delta in seconds
+   */
   float getset ()
   {
     float ret = get ();
@@ -44,6 +47,7 @@
     return ret;
   }
 
+  /** @brief set the start of the delta */
   void set ()
   {
     unsigned int ticks = SDL_GetTicks();
@@ -51,6 +55,7 @@
     last_time = ticks;
   }
 
+  /** @return the current delta in seconds */
   float get () const
   {
     unsigned int t = SDL_GetTicks();