removed small as otherwise the code was apparently unreadable in HTML docs

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

diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex
index e900499e26dc7da0f2d6c9660e45292d4c1f9834..a58d8b5ff45570e6c5f4928a126ee91080bc2c66 100644 (file)
--- a/docs/latex/wx/conditn.tex
+++ b/docs/latex/wx/conditn.tex
@@ -1,6 +1,18 @@
 \section{\class{wxCondition}}\label{wxcondition}
 
 \section{\class{wxCondition}}\label{wxcondition}
 

-TODO
+wxCondition variables correspond to pthread conditions or to Win32 event
+objects. They may be used in a multithreaded application to wait until the
+given condition becomes true which happens when the condition becomes signaled.
+
+For example, if a worker thread is doing some long task and another thread has
+to wait until it is finished, the latter thread will wait on the condition
+object and the worker thread will signal it on exit (this example is not
+perfect because in this particular case it would be much better to just 
+\helpref{Wait()}{wxthreadwait} for the worker thread, but if there are several
+worker threads it already makes much more sense).
+
+Once the thread(s) are signaled, the condition then resets to the not
+signaled state, ready to fire again.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -42,18 +54,16 @@ Signals the object.
 
 \membersection{wxCondition::Wait}\label{wxconditionwait}
 
 
 \membersection{wxCondition::Wait}\label{wxconditionwait}
 

-\func{void}{Wait}{\param{wxMutex\&}{ mutex}}
+\func{void}{Wait}{\void}

 
 Waits indefinitely.
 
 
 Waits indefinitely.
 

-\func{bool}{Wait}{\param{wxMutex\&}{ mutex}, \param{unsigned long}{ sec}, \param{unsigned long}{ nsec}}
+\func{bool}{Wait}{\param{unsigned long}{ sec}, \param{unsigned long}{ nsec}}

 
 Waits until a signal is raised or the timeout has elapsed.
 
 \wxheading{Parameters}
 
 
 Waits until a signal is raised or the timeout has elapsed.
 
 \wxheading{Parameters}
 

-\docparam{mutex}{wxMutex object.}
-

 \docparam{sec}{Timeout in seconds}
 
 \docparam{nsec}{Timeout nanoseconds component (added to {\it sec}).}
 \docparam{sec}{Timeout in seconds}
 
 \docparam{nsec}{Timeout nanoseconds component (added to {\it sec}).}


@@ -62,4 +72,3 @@ Waits until a signal is raised or the timeout has elapsed.
 
 The second form returns if the signal was raised, or FALSE if there was a timeout.
 
 
 The second form returns if the signal was raised, or FALSE if there was a timeout.
 

-