X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2432b92dd7a837db13d3938a56c1959decd03203..8b0f8432d72fc44aa7247ab1c19c04103323feea:/docs/latex/wx/mutexlck.tex diff --git a/docs/latex/wx/mutexlck.tex b/docs/latex/wx/mutexlck.tex index 1db3945ac8..7dae1bb64e 100644 --- a/docs/latex/wx/mutexlck.tex +++ b/docs/latex/wx/mutexlck.tex @@ -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.