diff options
Diffstat (limited to 'src/corelib/thread/qwaitcondition.qdoc')
| -rw-r--r-- | src/corelib/thread/qwaitcondition.qdoc | 42 |
1 files changed, 12 insertions, 30 deletions
diff --git a/src/corelib/thread/qwaitcondition.qdoc b/src/corelib/thread/qwaitcondition.qdoc index 014d549477..8466eb13d2 100644 --- a/src/corelib/thread/qwaitcondition.qdoc +++ b/src/corelib/thread/qwaitcondition.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \class QWaitCondition @@ -75,12 +51,12 @@ simultaneously are unpredictable. Wait conditions are a powerful thread synchronization primitive. - The \l{Wait Conditions Example} example shows how - to use QWaitCondition as an alternative to QSemaphore for - controlling access to a circular buffer shared by a producer + The \l{Producer and Consumer using Wait Conditions} example + shows how to use QWaitCondition as an alternative to QSemaphore + for controlling access to a circular buffer shared by a producer thread and a consumer thread. - \sa QMutex, QSemaphore, QThread, {Wait Conditions Example} + \sa QMutex, QSemaphore, QThread, {Producer and Consumer using Wait Conditions} */ /*! @@ -122,10 +98,16 @@ /*! \fn bool QWaitCondition::wait(QMutex *lockedMutex, unsigned long time) \overload + + Releases the \a lockedMutex and waits on the wait condition for \a time + milliseconds. */ /*! \fn bool QWaitCondition::wait(QReadWriteLock *lockedReadWriteLock, unsigned long time) \overload + + Releases the \a lockedReadWriteLock and waits on the wait condition for \a + time milliseconds. */ /*! |