remove C++ comment

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

diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex
index 42fef3052eae0d6f281df4d8a2ddcc6ba6f7a91b..cf3a6df6081e9565348bab0508b8254d69d4209a 100644 (file)
--- a/docs/latex/wx/conditn.tex
+++ b/docs/latex/wx/conditn.tex
@@ -13,8 +13,12 @@ worker threads it already makes much more sense).
 
 Note that a call to \helpref{Signal()}{wxconditionsignal} may happen before the
 other thread calls \helpref{Wait()}{wxconditionwait} and, just as with the
-pthread conditions, the signal is then lost and so if you want to be sure to
-get it you must use a mutex together with the condition variable.
+pthread conditions, the signal is then lost and so if you want to be sure that
+you don't miss it you must keep the mutex associated with the condition
+initially locked and lock it again before calling 
+\helpref{Signal()}{wxconditionsignal}. Of course, this means that this call is
+going to block until \helpref{Wait()}{wxconditionwait} is called by another
+thread.
 
 \wxheading{Example}
 
@@ -101,13 +105,17 @@ None.
 
 <wx/thread.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxCondition::wxCondition}\label{wxconditionconstr}
+\membersection{wxCondition::wxCondition}\label{wxconditionctor}
 
 \func{}{wxCondition}{\param{wxMutex\& }{mutex}}
 
@@ -115,9 +123,9 @@ Default and only constructor. The {\it mutex} must be locked by the caller
 before calling \helpref{Wait}{wxconditionwait} function.
 
 Use \helpref{IsOk}{wxconditionisok} to check if the object was successfully
-intiialized.
+initialized.
 
-\membersection{wxCondition::\destruct{wxCondition}}
+\membersection{wxCondition::\destruct{wxCondition}}\label{wxconditiondtor}
 
 \func{}{\destruct{wxCondition}}{\void}
 
@@ -141,7 +149,7 @@ not.
 \constfunc{bool}{IsOk}{\void}
 
 Returns {\tt true} if the object had been initialized successfully, {\tt false} 
-if an error occured.
+if an error occurred.
 
 \membersection{wxCondition::Signal}\label{wxconditionsignal}
 
@@ -168,7 +176,8 @@ Waits until the condition is signalled.
 This method atomically releases the lock on the mutex associated with this
 condition (this is why it must be locked prior to calling Wait) and puts the
 thread to sleep until \helpref{Signal}{wxconditionsignal} or 
-\helpref{Broadcast}{wxconditionbroadcast} is called.
+\helpref{Broadcast}{wxconditionbroadcast} is called. It then locks the mutex
+again and returns.
 
 Note that even if \helpref{Signal}{wxconditionsignal} had been called before
 Wait without waking up any thread, the thread would still wait for another one
@@ -177,7 +186,7 @@ Wait or the thread may sleep forever.
 
 \wxheading{Return value}
 
-Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occured.
+Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occurred.
 
 \wxheading{See also}
 
@@ -186,7 +195,7 @@ Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occured.
 
 \membersection{wxCondition::WaitTimeout}\label{wxconditionwaittimeout}
 
-\func{wxCondError}{Wait}{\param{unsigned long}{ milliseconds}}
+\func{wxCondError}{WaitTimeout}{\param{unsigned long}{ milliseconds}}
 
 Waits until the condition is signalled or the timeout has elapsed.
 
@@ -201,6 +210,6 @@ timeout expires.
 \wxheading{Return value}
 
 Returns {\tt wxCOND\_NO\_ERROR} if the condition was signalled, 
-{\tt wxCOND\_TIMEOUT} if the timeout elapsed ebfore this happened or another
+{\tt wxCOND\_TIMEOUT} if the timeout elapsed before this happened or another
 error code from wxCondError enum.