]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/mutexlck.tex
Bug 1099143 and more occurences of the same set vs. get mistakes.
[wxWidgets.git] / docs / latex / wx / mutexlck.tex
index 1db3945ac8016452f27e6dd46034c0b7c3bc8277..7dae1bb64e9ba13d3d2f1b98e9cb2d95145923be 100644 (file)
@@ -11,6 +11,10 @@ usage.
 
 None.
 
 
 None.
 
+\wxheading{Include files}
+
+<wx/thread.h>
+
 \wxheading{See also}
 
 \helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
 \wxheading{See also}
 
 \helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
@@ -19,21 +23,21 @@ None.
 
 \membersection{wxMutexLocker::wxMutexLocker}\label{wxmutexlockerctor}
 
 
 \membersection{wxMutexLocker::wxMutexLocker}\label{wxmutexlockerctor}
 
-\func{}{wxMutexLocker}{\param{wxMutex *}{mutex}}
+\func{}{wxMutexLocker}{\param{wxMutex\&}{ mutex}}
 
 
-Constructs a wxMutexLocker object associated with mutex which must be non NULL
-and locks it. Call \helpref{IsLocked}{wxmutexlockerisok} to check if the mutex was
+Constructs a wxMutexLocker object associated with mutex and locks it.
+Call \helpref{IsLocked}{wxmutexlockerisok} to check if the mutex was
 successfully locked.
 
 \membersection{wxMutexLocker::\destruct{wxMutexLocker}}\label{wxmutexlockerdtor}
 
 \func{}{\destruct{wxMutexLocker}}{\void}
 
 successfully locked.
 
 \membersection{wxMutexLocker::\destruct{wxMutexLocker}}\label{wxmutexlockerdtor}
 
 \func{}{\destruct{wxMutexLocker}}{\void}
 
-Destuctor releases the mutex if it was successfully acquired in the ctor.
+Destructor releases the mutex if it was successfully acquired in the ctor.
 
 \membersection{wxMutexLocker::IsOk}\label{wxmutexlockerisok}
 
 \constfunc{bool}{IsOk}{\void}
 
 
 \membersection{wxMutexLocker::IsOk}\label{wxmutexlockerisok}
 
 \constfunc{bool}{IsOk}{\void}
 
-Returns TRUE if mutex was acquired in the constructor, FALSE otherwise.
+Returns true if mutex was acquired in the constructor, false otherwise.