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>
This commit is contained in:
Thiago Macieira 2013-04-22 07:53:36 -07:00 committed by The Qt Project
parent e5e54a9ceb
commit ccb7db2ee3
1 changed files with 2 additions and 2 deletions

View File

@ -124,8 +124,8 @@
Releases the \a lockedMutex and waits on the wait condition. The Releases the \a lockedMutex and waits on the wait condition. The
\a lockedMutex must be initially locked by the calling thread. If \a \a lockedMutex must be initially locked by the calling thread. If \a
lockedMutex is not in a locked state, this function returns lockedMutex is not in a locked state, the behavior is undefined. If
immediately. If \a lockedMutex is a recursive mutex, this function \a lockedMutex is a recursive mutex, this function
returns immediately. The \a lockedMutex will be unlocked, and the returns immediately. The \a lockedMutex will be unlocked, and the
calling thread will block until either of these conditions is met: calling thread will block until either of these conditions is met: