remove misleading documentation of minPage in GetPageInfo() (see ticket #9502)

[wxWidgets.git] / interface / stopwatch.h

diff --git a/interface/stopwatch.h b/interface/stopwatch.h
index 883c0b5aa8d4f36202cceb4c9962991bd1dd608b..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
@@ -28,8 +28,7 @@
     @library{wxbase}
     @category{misc}
 
-    @seealso
-    wxTimer
+    @see wxTimer
 */
 class wxStopWatch
 {
@@ -42,7 +41,6 @@ public:
     /**
         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
         Start() to resume it unconditionally.
@@ -65,32 +63,44 @@ public:
         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.
+    Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
+
+    @see wxDateTime::Now(), wxLongLong
 
-    @sa wxDateTime::Now
+    @header{wx/stopwatch.h}
 */
-long wxGetUTCTime();
+wxLongLong wxGetLocalTimeMillis();
 
 /**
-    Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
+    Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
+
+    @see wxDateTime::Now()
 
-    @sa wxDateTime::Now, wxLongLong
+    @header{wx/stopwatch.h}
 */
-wxLongLong wxGetLocalTimeMillis();
+long wxGetUTCTime();
+
+//@}