More wxMutex doc updates
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55466 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -825,8 +825,7 @@ class wxMutexLocker
|
|||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
Constructs a wxMutexLocker object associated with mutex and locks it.
|
Constructs a wxMutexLocker object associated with mutex and locks it.
|
||||||
Call @ref IsOk() IsLocked to check if the mutex was
|
Call IsOk() to check if the mutex was successfully locked.
|
||||||
successfully locked.
|
|
||||||
*/
|
*/
|
||||||
wxMutexLocker(wxMutex& mutex);
|
wxMutexLocker(wxMutex& mutex);
|
||||||
|
|
||||||
@@ -955,28 +954,28 @@ public:
|
|||||||
Locks the mutex object. This is equivalent to
|
Locks the mutex object. This is equivalent to
|
||||||
LockTimeout() with infinite timeout.
|
LockTimeout() with infinite timeout.
|
||||||
|
|
||||||
@return One of:
|
@return One of: @c wxMUTEX_NO_ERROR, @c wxMUTEX_DEAD_LOCK.
|
||||||
*/
|
*/
|
||||||
wxMutexError Lock();
|
wxMutexError Lock();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Try to lock the mutex object during the specified time interval.
|
Try to lock the mutex object during the specified time interval.
|
||||||
|
|
||||||
@return One of:
|
@return One of: @c wxMUTEX_NO_ERROR, @c wxMUTEX_DEAD_LOCK, @c wxMUTEX_TIMEOUT.
|
||||||
*/
|
*/
|
||||||
wxMutexError LockTimeout(unsigned long msec);
|
wxMutexError LockTimeout(unsigned long msec);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Tries to lock the mutex object. If it can't, returns immediately with an error.
|
Tries to lock the mutex object. If it can't, returns immediately with an error.
|
||||||
|
|
||||||
@return One of:
|
@return One of: @c wxMUTEX_NO_ERROR, @c wxMUTEX_BUSY.
|
||||||
*/
|
*/
|
||||||
wxMutexError TryLock();
|
wxMutexError TryLock();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Unlocks the mutex object.
|
Unlocks the mutex object.
|
||||||
|
|
||||||
@return One of:
|
@return One of: @c wxMUTEX_NO_ERROR, @c wxMUTEX_UNLOCKED.
|
||||||
*/
|
*/
|
||||||
wxMutexError Unlock();
|
wxMutexError Unlock();
|
||||||
};
|
};
|
||||||
|
Reference in New Issue
Block a user