classic/carbon split

[wxWidgets.git] / docs / latex / wx / stopwtch.tex

diff --git a/docs/latex/wx/stopwtch.tex b/docs/latex/wx/stopwtch.tex
index 98b60ed19fe38c232caaa873b8b77527a6999d97..473f4ec2994a58cd258012f92d7f59fccadd64e8 100644 (file)
--- a/docs/latex/wx/stopwtch.tex
+++ b/docs/latex/wx/stopwtch.tex
@@ -1,6 +1,19 @@
 \section{\class{wxStopWatch}}\label{wxstopwatch}
 
 \section{\class{wxStopWatch}}\label{wxstopwatch}
 

-The wxStopWatch class allow you to measure time intervalls. 
+The wxStopWatch class allow you to measure time intervals. For example, you may
+use it to measure the time elapsed by some function:
+
+\begin{verbatim}
+    wxStopWatch sw;
+    CallLongRunningFunction();
+    wxLogMessage("The long running function took %ldms to execute",
+                 sw.Time());
+    sw.Pause();
+    ... stopwatch is stopped now ...
+    sw.Resume();
+    CallLongRunningFunction();
+    wxLogMessage("And calling it twice took $ldms in all", sw.Time());
+\end{verbatim}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -25,21 +38,26 @@ Constructor. This starts the stop watch.
 Pauses the stop watch. Call \helpref{wxStopWatch::Resume}{wxstopwatchresume} to resume 
 time measuring again.
 
 Pauses the stop watch. Call \helpref{wxStopWatch::Resume}{wxstopwatchresume} to resume 
 time measuring again.
 

-\membersection{wxStopWatch::Start}
-
-\func{void}{Start}{\param{long}{ milliseconds = 0}}
-
-(Re)starts the stop watch with a given initial value.
+If this method is called several times, {\tt Resume()} must be called the same
+number of times to really resume the stop watch. You may, however, call 
+\helpref{Start}{wxstopwatchstart} to resume it unconditionally.

 
 \membersection{wxStopWatch::Resume}\label{wxstopwatchresume}
 
 \func{void}{Resume}{\void}
 
 
 \membersection{wxStopWatch::Resume}\label{wxstopwatchresume}
 
 \func{void}{Resume}{\void}
 

-Resumes the stop watch after having been paused with \helpref{wxStopWatch::Pause}{wxstopwatchpause}.
+Resumes the stop watch which had been paused with 
+\helpref{wxStopWatch::Pause}{wxstopwatchpause}.
+
+\membersection{wxStopWatch::Start}\label{wxstopwatchstart}
+
+\func{void}{Start}{\param{long}{ milliseconds = 0}}
+
+(Re)starts the stop watch with a given initial value.

 
 \membersection{wxStopWatch::Time}
 
 
 \membersection{wxStopWatch::Time}
 

-\func{long}{Time}{\void}\label{wxstopwatchtime}
+\constfunc{long}{Time}{\void}\label{wxstopwatchtime}

 
 Returns the time in milliseconds since the start (or restart) or the last call of 
 \helpref{wxStopWatch::Pause}{wxstopwatchpause}.
 
 Returns the time in milliseconds since the start (or restart) or the last call of 
 \helpref{wxStopWatch::Pause}{wxstopwatchpause}.