X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..c36cdfc084f779b67668af8cad3eb6906182af21:/docs/latex/wx/mutexlck.tex?ds=sidebyside diff --git a/docs/latex/wx/mutexlck.tex b/docs/latex/wx/mutexlck.tex index 5fa53b7354..afd06be4a6 100644 --- 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. @@ -15,6 +15,10 @@ None. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker} @@ -23,10 +27,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 +43,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.