Minor correction

[wxWidgets.git] / interface / stopwatch.h

diff --git a/interface/stopwatch.h b/interface/stopwatch.h
index 8df3137f8ade8672df06ca92c8e0969be7a747ed..3dfba4a146301708c94bae18f837840140c9f03c 100644 (file)
--- a/interface/stopwatch.h
+++ b/interface/stopwatch.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stopwatch.h
-// Purpose:     documentation for wxStopWatch class
+// Purpose:     interface of wxStopWatch
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,10 +9,10 @@
 /**
     @class wxStopWatch
     @wxheader{stopwatch.h}
-    
+
     The wxStopWatch class allow you to measure time intervals. For example, you may
     use it to measure the time elapsed by some function:
-    
+
     @code
     wxStopWatch sw;
         CallLongRunningFunction();
@@ -24,14 +24,13 @@
         CallLongRunningFunction();
         wxLogMessage("And calling it twice took $ldms in all", sw.Time());
     @endcode
-    
+
     @library{wxbase}
     @category{misc}
-    
-    @seealso
-    wxTimer
+
+    @see wxTimer
 */
-class wxStopWatch 
+class wxStopWatch
 {
 public:
     /**
@@ -40,17 +39,16 @@ public:
     wxStopWatch();
 
     /**
-        Pauses the stop watch. Call Resume() to resume 
+        Pauses the stop watch. Call Resume() to resume
         time measuring again.
-        
         If this method is called several times, @c Resume() must be called the same
-        number of times to really resume the stop watch. You may, however, call 
+        number of times to really resume the stop watch. You may, however, call
         Start() to resume it unconditionally.
     */
     void Pause();
 
     /**
-        Resumes the stop watch which had been paused with 
+        Resumes the stop watch which had been paused with
         Pause().
     */
     void Resume();
@@ -62,35 +60,47 @@ public:
 
     /**
         Returns the time in milliseconds since the start (or restart) or the last call
-        of 
+        of
         Pause().
     */
-    long Time();
+    long Time() const;
 };
 
 
+
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
+/** @ingroup group_funcmacro_time */
+//@{
+
 /**
     Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
-    
-    @sa wxDateTime::Now
+
+    @see wxDateTime::Now()
+
+    @header{wx/stopwatch.h}
 */
 long wxGetLocalTime();
 
 /**
-    Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
-    
-    @sa wxDateTime::Now
+    Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
+
+    @see wxDateTime::Now(), wxLongLong
+
+    @header{wx/stopwatch.h}
 */
-long wxGetUTCTime();
+wxLongLong wxGetLocalTimeMillis();
 
 /**
-    Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
-    
-    @sa wxDateTime::Now, wxLongLong
+    Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
+
+    @see wxDateTime::Now()
+
+    @header{wx/stopwatch.h}
 */
-wxLongLong wxGetLocalTimeMillis();
+long wxGetUTCTime();
+
+//@}