]> git.saurik.com Git - wxWidgets.git/commitdiff
More wxMutex doc updates
authorRobert Roebling <robert@roebling.de>
Fri, 5 Sep 2008 08:16:36 +0000 (08:16 +0000)
committerRobert Roebling <robert@roebling.de>
Fri, 5 Sep 2008 08:16:36 +0000 (08:16 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55466 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/thread.h

index c57540f4b33f47f4bf020d59053bf70c7727b5d7..4b0ebf0ee0b2e156435fda79efc5d551a77229ad 100644 (file)
@@ -825,8 +825,7 @@ class wxMutexLocker
 public:
     /**
         Constructs a wxMutexLocker object associated with mutex and locks it.
-        Call @ref IsOk() IsLocked to check if the mutex was
-        successfully locked.
+        Call IsOk() to check if the mutex was successfully locked.
     */
     wxMutexLocker(wxMutex& mutex);
 
@@ -955,28 +954,28 @@ public:
         Locks the mutex object. This is equivalent to
         LockTimeout() with infinite timeout.
 
-        @return One of:
+        @return One of: @c wxMUTEX_NO_ERROR, @c wxMUTEX_DEAD_LOCK.
     */
     wxMutexError Lock();
 
     /**
         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);
 
     /**
         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();
 
     /**
         Unlocks the mutex object.
 
-        @return One of:
+        @return One of: @c wxMUTEX_NO_ERROR, @c wxMUTEX_UNLOCKED.
     */
     wxMutexError Unlock();
 };