First attempt to document raw bitmap access

[wxWidgets.git] / interface / timer.h

diff --git a/interface/timer.h b/interface/timer.h
index d9f99ec7b4328571e3b700327b33f82fe0259dcb..49de74c8ef1aaffd87a33c9a20baded614ee260a 100644 (file)
--- a/interface/timer.h
+++ b/interface/timer.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        timer.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        timer.h

-// Purpose:     documentation for wxTimer class
+// Purpose:     interface of wxTimer

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -32,13 +32,12 @@
     after constructing it before it actually starts sending notifications. It can
     be stopped later with wxTimer::Stop.
 
     after constructing it before it actually starts sending notifications. It can
     be stopped later with wxTimer::Stop.
 

-    @b Note: A timer can only be used from the main thread.
+    @note A timer can only be used from the main thread.

 
     @library{wxbase}
     @category{misc}
 
 
     @library{wxbase}
     @category{misc}
 

-    @seealso
-    wxStopWatch
+    @see wxStopWatch

 */
 class wxTimer : public wxEvtHandler
 {
 */
 class wxTimer : public wxEvtHandler
 {


@@ -60,30 +59,30 @@ public:
     /**
         Returns the ID of the events generated by this timer.
     */
     /**
         Returns the ID of the events generated by this timer.
     */

-    int GetId();
+    int GetId() const;

 
     /**
         Returns the current interval for the timer (in milliseconds).
     */
 
     /**
         Returns the current interval for the timer (in milliseconds).
     */

-    int GetInterval();
+    int GetInterval() const;

 
     /**
         Returns the current @e owner of the timer.
         If non-@NULL this is the event handler which will receive the
         @ref overview_wxtimerevent "timer events" when the timer is running.
     */
 
     /**
         Returns the current @e owner of the timer.
         If non-@NULL this is the event handler which will receive the
         @ref overview_wxtimerevent "timer events" when the timer is running.
     */

-    wxEvtHandler GetOwner();
+    wxEvtHandler GetOwner() const;

 
     /**
         Returns @true if the timer is one shot, i.e. if it will stop after firing the
         first notification automatically.
     */
 
     /**
         Returns @true if the timer is one shot, i.e. if it will stop after firing the
         first notification automatically.
     */

-    bool IsOneShot();
+    bool IsOneShot() const;

 
     /**
         Returns @true if the timer is running, @false if it is stopped.
     */
 
     /**
         Returns @true if the timer is running, @false if it is stopped.
     */

-    bool IsRunning();
+    bool IsRunning() const;

 
     /**
         This member should be overridden by the user if the default constructor was
 
     /**
         This member should be overridden by the user if the default constructor was


@@ -107,15 +106,15 @@ public:
         function will be called repeatedly until the timer is stopped. If @true,
         it will be called only once and the timer will stop automatically. To make your
         code more readable you may also use the following symbolic constants:
         function will be called repeatedly until the timer is stopped. If @true,
         it will be called only once and the timer will stop automatically. To make your
         code more readable you may also use the following symbolic constants:

-        
+

         wxTIMER_CONTINUOUS
         wxTIMER_CONTINUOUS

-        
+

         Start a normal, continuously running, timer
         Start a normal, continuously running, timer

-        
+

         wxTIMER_ONE_SHOT
         wxTIMER_ONE_SHOT

-        
+

         Start a one shot timer
         Start a one shot timer

-        
+

         If the timer was already running, it will be stopped by this method before
         restarting it.
     */
         If the timer was already running, it will be stopped by this method before
         restarting it.
     */


@@ -128,6 +127,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxTimerEvent
     @wxheader{timer.h}
 /**
     @class wxTimerEvent
     @wxheader{timer.h}


@@ -166,8 +166,7 @@ public:
     @library{wxbase}
     @category{events}
 
     @library{wxbase}
     @category{events}
 

-    @seealso
-    wxTimer
+    @see wxTimer

 */
 class wxTimerEvent : public wxEvent
 {
 */
 class wxTimerEvent : public wxEvent
 {


@@ -175,10 +174,11 @@ public:
     /**
         Returns the interval of the timer which generated this event.
     */
     /**
         Returns the interval of the timer which generated this event.
     */

-    int GetInterval();
+    int GetInterval() const;

 
     /**
         Returns the timer object which generated this event.
     */
 
     /**
         Returns the timer object which generated this event.
     */

-    wxTimer GetTimer();
+    wxTimer GetTimer() const;

 };
 };

+