]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/mutexlck.tex
clarify global wxConfig object life-management
[wxWidgets.git] / docs / latex / wx / mutexlck.tex
index 5fa53b7354c2f8f9720b781b80a75351ba7efe36..9fbfbaec9c60815211e376669b3210c2a785b079 100644 (file)
@@ -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.
 
@@ -23,10 +23,10 @@ None.
 
 \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}
@@ -39,5 +39,5 @@ Destructor releases the mutex if it was successfully acquired in the ctor.
 
 \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.