X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2432b92dd7a837db13d3938a56c1959decd03203..034ad06337f97ffa3742fd8d9a8df2a4e9d5ed4a:/docs/latex/wx/mutexlck.tex diff --git a/docs/latex/wx/mutexlck.tex b/docs/latex/wx/mutexlck.tex index 1db3945ac8..9fbfbaec9c 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. @@ -11,6 +11,10 @@ usage. None. +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker} @@ -19,21 +23,21 @@ 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} \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.