added null pointer check and assert

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

diff --git a/docs/latex/wx/mutexlck.tex b/docs/latex/wx/mutexlck.tex
index b0d565663cc9dc29a9865fb784e670fb4dc87d32..afd06be4a6b09799b800ade247e3f798e39ab3b1 100644 (file)
--- a/docs/latex/wx/mutexlck.tex
+++ b/docs/latex/wx/mutexlck.tex
@@ -3,7 +3,7 @@
 This is a small helper class to be used with \helpref{wxMutex}{wxmutex} 
 objects. A wxMutexLocker acquires a mutex lock in the constructor and releases
 (or unlocks) the mutex in the destructor making it much more difficult to
-forget to release a mutex (which, in general, will promptly lead to the serious
+forget to release a mutex (which, in general, will promptly lead to serious
 problems). See \helpref{wxMutex}{wxmutex} for an example of wxMutexLocker
 usage.
 
@@ -11,26 +11,37 @@ usage.
 
 None.
 
+\wxheading{Include files}
+
+<wx/thread.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
-\helpref{wxMutex}{wxmutex},
-\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
+\helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxMutexLocker::wxMutexLocker}\label{wxmutexlockerctor}
-\func{}{wxMutexLocker}{\param{wxMutex *}{mutex}}
 
-Constructs a wxMutexLocker object associated with mutex which must be non NULL
-and locks it. Call \helpref{IsOk}{wxmutexisok} to check if the mutex was
+\func{}{wxMutexLocker}{\param{wxMutex\&}{ mutex}}
+
+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}
 
-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}
 
-Returns TRUE if mutex was acquired in the constructor, FALSE otherwise.
+Returns true if mutex was acquired in the constructor, false otherwise.
+