summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThiago Macieira <thiago.macieira@intel.com>2013-04-22 07:53:36 -0700
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-04-22 18:35:52 +0200
commitccb7db2ee35b8efb0030283856a9b9f5a1ff419d (patch)
treea6baf748681b90c6829ea2dd7a641ac3f0509147
parente5e54a9ceb760e992001e0846a9b608107b13620 (diff)
Document that the mutex passed to QWaitCondition::wait must be locked
Simply say that the behaviour is undefined if you don't do what you must do. I don't want to introduce a check: it can't be done reliably anyway. Task-number: QTBUG-30806 Change-Id: Iba1bbbdfe62ffcb133f9c52215efdcc0ee7bd9bd Reviewed-by: Olivier Goffart <ogoffart@woboq.com>
-rw-r--r--src/corelib/thread/qwaitcondition.qdoc4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/corelib/thread/qwaitcondition.qdoc b/src/corelib/thread/qwaitcondition.qdoc
index 68788e0b3f..9aa633a210 100644
--- a/src/corelib/thread/qwaitcondition.qdoc
+++ b/src/corelib/thread/qwaitcondition.qdoc
@@ -124,8 +124,8 @@
Releases the \a lockedMutex and waits on the wait condition. The
\a lockedMutex must be initially locked by the calling thread. If \a
- lockedMutex is not in a locked state, this function returns
- immediately. If \a lockedMutex is a recursive mutex, this function
+ lockedMutex is not in a locked state, the behavior is undefined. If
+ \a lockedMutex is a recursive mutex, this function
returns immediately. The \a lockedMutex will be unlocked, and the
calling thread will block until either of these conditions is met: