cross-reference types in the generated docs (patch 1038083)

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

diff --git a/docs/latex/wx/mutex.tex b/docs/latex/wx/mutex.tex
index c992dbe79acd269ff60b4577e9b279df53da677b..db784aeea4a8532abaed647d3033f164f93b43fe 100644 (file)
--- a/docs/latex/wx/mutex.tex
+++ b/docs/latex/wx/mutex.tex
@@ -3,7 +3,15 @@
 A mutex object is a synchronization object whose state is set to signaled when
 it is not owned by any thread, and nonsignaled when it is owned. Its name comes
 from its usefulness in coordinating mutually-exclusive access to a shared
-resource. Only one thread at a time can own a mutex object.
+resource as only one thread at a time can own a mutex object.
+
+Mutexes may be recursive in the sense that a thread can lock a mutex which it
+had already locked before (instead of dead locking the entire process in this
+situation by starting to wait on a mutex which will never be released while the
+thread is waiting) but using them is not recommended and they are {\bf not}
+recursive by default. The reason for this is that recursive mutexes are not
+supported by all Unix flavours and, worse, they cannot be used with 
+\helpref{wxCondition}{wxcondition}.
 
 For example, when several thread use the data stored in the linked list,
 modifications to the list should be only allowed to one thread at a time
@@ -33,7 +41,7 @@ because during a new node addition the list integrity is temporarily broken
         s_mutexProtectingTheGlobalList->Unlock();
     }
 
-    // return TRUE the given number is greater than all array elements
+    // return true the given number is greater than all array elements
     bool MyThread::IsGreater(int num)
     {
         // before using the list we must acquire the mutex
@@ -43,49 +51,60 @@ because during a new node addition the list integrity is temporarily broken
         for ( size_t n = 0; n < count; n++ )
         {
             if ( s_data[n] > num )
-                return FALSE;
+                return false;
         }
 
-        return TRUE;
+        return true;
     }
 \end{verbatim}
 }
 
 Notice how wxMutexLocker was used in the second function to ensure that the
-mutex is unlocked in any case: whether the function returns TRUE or FALSE
+mutex is unlocked in any case: whether the function returns true or false
 (because the destructor of the local object {\it lock} is always called). Using
 this class instead of directly using wxMutex is, in general safer and is even
-more so if yoor program uses C++ exceptions.
+more so if your program uses C++ exceptions.
+
+\wxheading{Constants}
+
+\begin{verbatim}
+enum wxMutexType
+{
+    // normal mutex: try to always use this one
+    wxMUTEX_DEFAULT,
+
+    // recursive mutex: don't use these ones with wxCondition
+    wxMUTEX_RECURSIVE
+};
+\end{verbatim}
 
 \wxheading{Derived from}
 
 None.
 
+\wxheading{Include files}
+
+<wx/thread.h>
+
 \wxheading{See also}
 
-\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition},
+\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition}, 
 \helpref{wxMutexLocker}{wxmutexlocker}, \helpref{wxCriticalSection}{wxcriticalsection}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMutex::wxMutex}\label{wxmutexconstr}
+\membersection{wxMutex::wxMutex}\label{wxmutexctor}
 
-\func{}{wxMutex}{\void}
+\func{}{wxMutex}{\param{wxMutexType }{type = {\tt wxMUTEX\_DEFAULT}}}
 
 Default constructor.
 
-\membersection{wxMutex::\destruct{wxMutex}}
+\membersection{wxMutex::\destruct{wxMutex}}\label{wxmutexdtor}
 
 \func{}{\destruct{wxMutex}}{\void}
 
 Destroys the wxMutex object.
 
-\membersection{wxMutex::IsLocked}\label{wxmutexislocked}
-
-\constfunc{bool}{IsLocked}{\void}
-
-Returns TRUE if the mutex is locked, FALSE otherwise.
-
 \membersection{wxMutex::Lock}\label{wxmutexlock}
 
 \func{wxMutexError}{Lock}{\void}
@@ -138,4 +157,3 @@ One of:
 \twocolitem{{\bf wxMUTEX\_UNLOCKED}}{The calling thread tries to unlock an unlocked mutex.}
 \end{twocollist}
 
-