Browse Source

[2332] updated doc for wait() on what should happen if mutex isn't locked.

mentioning pthread_cond_wait() seems to be confusing, so I'd rather
just describing what this method does.
JINMEI Tatuya 12 years ago
parent
commit
410987bf3c
1 changed files with 3 additions and 4 deletions
  1. 3 4
      src/lib/util/threads/lock.h

+ 3 - 4
src/lib/util/threads/lock.h

@@ -180,10 +180,9 @@ public:
     /// \brief Wait on the condition variable.
     ///
     /// This method works like \c pthread_cond_wait().  For mutex it takes
-    /// an \c Mutex class object.  Unlike \c pthread_cond_wait(), however,
-    /// this method requires a lock for the mutex has been acquired.
-    /// If this condition isn't met, it can throw an exception (in the
-    /// debug mode build) or result in undefined behavior.
+    /// an \c Mutex class object.  A lock for the mutex must have been
+    /// acquired.  If this condition isn't met, it can throw an exception
+    /// (in the debug mode build) or result in undefined behavior.
     ///
     /// The lock will be automatically released within this method, and
     /// will be re-acquired on the exit of this method.