From 9390546335e0e007904f49504edd048d05caa339 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 12 Feb 2007 19:17:18 +0000 Subject: [PATCH] clarify Wait() semantics (see patch 1652076) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@44486 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/thread.tex | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/latex/wx/thread.tex b/docs/latex/wx/thread.tex index 7a8c8ee32c..ad1cb401fd 100644 --- a/docs/latex/wx/thread.tex +++ b/docs/latex/wx/thread.tex @@ -461,10 +461,11 @@ 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. -- 2.50.0