X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..c29c95fe24973b94fd724db767193171ca7c513d:/interface/wx/stopwatch.h diff --git a/interface/wx/stopwatch.h b/interface/wx/stopwatch.h index bd06d1d38b..3f2f98edbe 100644 --- a/interface/wx/stopwatch.h +++ b/interface/wx/stopwatch.h @@ -3,17 +3,18 @@ // Purpose: interface of wxStopWatch // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxStopWatch - 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()); @@ -38,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. @@ -47,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(); @@ -58,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; }; @@ -71,7 +70,7 @@ public: // Global functions/macros // ============================================================================ -/** @ingroup group_funcmacro_time */ +/** @addtogroup group_funcmacro_time */ //@{ /**