X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..058f225a44d83d42ba9d773efc705badbf0e5e3c:/interface/wx/stopwatch.h diff --git a/interface/wx/stopwatch.h b/interface/wx/stopwatch.h index 3dfba4a146..c99ffb0d1e 100644 --- a/interface/wx/stopwatch.h +++ b/interface/wx/stopwatch.h @@ -8,13 +8,13 @@ /** @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: + 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; + wxStopWatch sw; CallLongRunningFunction(); wxLogMessage("The long running function took %ldms to execute", sw.Time()); @@ -39,8 +39,8 @@ public: wxStopWatch(); /** - Pauses the stop watch. Call Resume() to resume - time measuring again. + 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. @@ -48,8 +48,7 @@ public: void Pause(); /** - Resumes the stop watch which had been paused with - Pause(). + Resumes the stop watch which had been paused with Pause(). */ void Resume(); @@ -59,9 +58,8 @@ public: void Start(long milliseconds = 0); /** - Returns the time in milliseconds since the start (or restart) or the last call - of - Pause(). + Returns the time in milliseconds since the start (or restart) or the last + call of Pause(). */ long Time() const; }; @@ -72,7 +70,7 @@ public: // Global functions/macros // ============================================================================ -/** @ingroup group_funcmacro_time */ +/** @addtogroup group_funcmacro_time */ //@{ /**