X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..16361ec94128d2cea3a08c2c84a4eb38232715d6:/interface/timer.h diff --git a/interface/timer.h b/interface/timer.h index 9fa88d5796..49de74c8ef 100644 --- a/interface/timer.h +++ b/interface/timer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: timer.h -// Purpose: documentation for wxTimer class +// Purpose: interface of wxTimer // 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. - @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} - @seealso - wxStopWatch + @see wxStopWatch */ class wxTimer : public wxEvtHandler { @@ -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: - + wxTIMER_CONTINUOUS - + Start a normal, continuously running, timer - + wxTIMER_ONE_SHOT - + Start a one shot timer - + 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} @@ -166,8 +166,7 @@ public: @library{wxbase} @category{events} - @seealso - wxTimer + @see wxTimer */ class wxTimerEvent : public wxEvent { @@ -182,3 +181,4 @@ public: */ wxTimer GetTimer() const; }; +