]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/conditn.tex
another patch bring the docs more up to date (patch 1717776)
[wxWidgets.git] / docs / latex / wx / conditn.tex
index 52dfc708460f8a9cfa2dc4df0adc14784acdaaff..1c31d62d801f5b7b4d6f9fc1c1d2a9b46e302797 100644 (file)
@@ -111,7 +111,7 @@ None.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxCondition::wxCondition}\label{wxconditionconstr}
+\membersection{wxCondition::wxCondition}\label{wxconditionctor}
 
 \func{}{wxCondition}{\param{wxMutex\& }{mutex}}
 
@@ -119,9 +119,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}
 
@@ -145,7 +145,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}
 
@@ -172,7 +172,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
@@ -181,7 +182,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}
 
@@ -190,7 +191,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.
 
@@ -205,6 +206,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.