Commit 410987bf authored by JINMEI Tatuya's avatar JINMEI Tatuya
Browse files

[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.
parent 7f94f671
......@@ -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.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment