Bug 1099143 and more occurences of the same set vs. get mistakes.

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

diff --git a/docs/latex/wx/thread.tex b/docs/latex/wx/thread.tex
index 9a504ebe5411b13e0df6457c4b04f2cbaade5c29..4cf259e208ee68dfdb4a0bc2c006be0de01aa946 100644 (file)
--- a/docs/latex/wx/thread.tex
+++ b/docs/latex/wx/thread.tex
@@ -4,11 +4,11 @@ A thread is basically a path of execution through a program. Threads are
 sometimes called {\it light-weight processes}, but the fundamental difference
 between threads and processes is that memory spaces of different processes are
 separated while all threads share the same address space. While it makes it
 sometimes called {\it light-weight processes}, but the fundamental difference
 between threads and processes is that memory spaces of different processes are
 separated while all threads share the same address space. While it makes it

-much easier to share common data between several threads, it also makes much
+much easier to share common data between several threads, it also makes it much

 easier to shoot oneself in the foot, so careful use of synchronization objects
 such as \helpref{mutexes}{wxmutex} and/or \helpref{critical sections}{wxcriticalsection} is recommended.
 
 easier to shoot oneself in the foot, so careful use of synchronization objects
 such as \helpref{mutexes}{wxmutex} and/or \helpref{critical sections}{wxcriticalsection} is recommended.
 

-There are two types of threads in wxWindows: {\it detached} and {\it joinable}
+There are two types of threads in wxWidgets: {\it detached} and {\it joinable}

 ones, just as in the POSIX thread API (but unlike Win32 threads where all threads
 are joinable). The difference between the two is that only joinable threads
 can return a return code -- this is returned by the Wait() function. Detached
 ones, just as in the POSIX thread API (but unlike Win32 threads where all threads
 are joinable). The difference between the two is that only joinable threads
 can return a return code -- this is returned by the Wait() function. Detached


@@ -26,7 +26,9 @@ heap because the thread will call {\tt delete this;} upon termination. Joinable
 threads may be created on the stack although more usually they will be created
 on the heap as well. Don't create global thread objects because they allocate
 memory in their constructor, which will cause problems for the memory checking
 threads may be created on the stack although more usually they will be created
 on the heap as well. Don't create global thread objects because they allocate
 memory in their constructor, which will cause problems for the memory checking

-system.
+system. Finally, another consequence of the handling of the above is that you
+should never delete a detached thread yourself, as this will be done by the
+thread itself when it terminates.

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


@@ -60,7 +62,7 @@ The possible values for {\it kind} parameters are:
 \end{twocollist}
 
 
 \end{twocollist}
 
 

-\membersection{wxThread::\destruct{wxThread}}
+\membersection{wxThread::\destruct{wxThread}}\label{wxthreaddtor}

 
 \func{}{\destruct{wxThread}}{\void}
 
 
 \func{}{\destruct{wxThread}}{\void}
 


@@ -134,7 +136,7 @@ be implemented by any derived class. The thread execution will start here.
 The returned value is the thread exit code which is only useful for
 joinable threads and is the value returned by \helpref{Wait}{wxthreadwait}.
 
 The returned value is the thread exit code which is only useful for
 joinable threads and is the value returned by \helpref{Wait}{wxthreadwait}.
 

-This function is called by wxWindows itself and should never be called
+This function is called by wxWidgets itself and should never be called

 directly.
 
 
 directly.
 
 


@@ -201,7 +203,7 @@ The following priorities are defined:
 
 Returns \true if the thread is alive (i.e. started and not terminating).
 
 
 Returns \true if the thread is alive (i.e. started and not terminating).
 

-Note that this function can only be saely used with joinable threads, not
+Note that this function can only be safely used with joinable threads, not

 detached ones as the latter delete themselves and so when the real thread is
 not alive any longer it is not possible to call this function neither because
 the wxThread object doesn't exist any more as well.
 detached ones as the latter delete themselves and so when the real thread is
 not alive any longer it is not possible to call this function neither because
 the wxThread object doesn't exist any more as well.