]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/thread.tex
remove C++ comment
[wxWidgets.git] / docs / latex / wx / thread.tex
index 12f9020b7401d7de4b3717eab94541d6f3aba729..73ff7635285573a3319f9ca2eacf3a645792de8a 100644 (file)
@@ -19,6 +19,10 @@ None.
 
 <wx/thread.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxMutex}{wxmutex}, \helpref{wxCondition}{wxcondition}, \helpref{wxCriticalSection}{wxcriticalsection}
@@ -461,13 +465,15 @@ See also \helpref{Sleep()}{wxthreadsleep}.
 
 \constfunc{ExitCode}{Wait}{\void}
 
-Gracefully terminates a joinable thread, either when the thread calls 
-\helpref{TestDestroy}{wxthreadtestdestroy} or finished processing, and 
-returns the value the thread returned from 
-\helpref{wxThread::Entry}{wxthreadentry} or {\tt (ExitCode)-1} on error. 
+Waits for a joinable thread to terminate and returns the value the thread
+returned from \helpref{wxThread::Entry}{wxthreadentry} or {\tt (ExitCode)-1} on
+error. Notice that, unlike \helpref{Delete}{wxthreaddelete} doesn't cancel the
+thread in any way so the caller waits for as long as it takes to the thread to
+exit.
 
 You can only Wait() for joinable (not detached) threads.
 
 This function can only be called from another thread context.
 
 See \helpref{wxThread deletion}{deletionwxthread} for a broader explanation of this routine.
+