summaryrefslogtreecommitdiffstats
path: root/src/corelib/thread/qmutex.cpp
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@qt.io>2016-11-29 11:43:40 +0100
committerMartin Smith <martin.smith@qt.io>2017-01-06 20:18:19 +0000
commit9605f4f47bf4b628aa2b316617178b7b123456d3 (patch)
tree008b979c34b98fe925258fa83a3a2bae4a2c5c3c /src/corelib/thread/qmutex.cpp
parent0e810e27a5e5a6c2e244ca439fbdf4f4ccc5b3da (diff)
doc: clangqdoc documents the threads case
qmutex.h is updated to let clangqdoc document the threads case, because the no-threads case is not interesting, and clang can handle everything declared in qmutex.h. This change required that a few minor qdoc errors be corrected in qmutex.cpp as well. Change-Id: Icb4122f2179d6aad39dc68376498364820143297 Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/corelib/thread/qmutex.cpp')
-rw-r--r--src/corelib/thread/qmutex.cpp14
1 files changed, 12 insertions, 2 deletions
diff --git a/src/corelib/thread/qmutex.cpp b/src/corelib/thread/qmutex.cpp
index 653c3efe1c..6887fa247b 100644
--- a/src/corelib/thread/qmutex.cpp
+++ b/src/corelib/thread/qmutex.cpp
@@ -266,6 +266,9 @@ bool QMutex::tryLock(int timeout) QT_MUTEX_LOCK_NOEXCEPT
/*! \fn bool QMutex::try_lock()
\since 5.8
+ Attempts to lock the mutex. This function returns \c true if the lock
+ was obtained; otherwise it returns \c false.
+
This function is provided for compatibility with the Standard Library
concept \c Lockable. It is equivalent to tryLock().
*/
@@ -336,16 +339,23 @@ void QMutex::unlock() Q_DECL_NOTHROW
unlockInternal();
}
+
+/*!
+ \fn bool QMutex::isRecursive() const
+ \since 5.7
+
+ Returns \c true if the mutex is recursive.
+*/
+
bool QBasicMutex::isRecursive() Q_DECL_NOTHROW
{
return QT_PREPEND_NAMESPACE(isRecursive)(d_ptr.loadAcquire());
}
/*!
- \overload
\since 5.7
- Returns \c true if the mutex is recursive
+ Returns \c true if the mutex is recursive.
*/
bool QBasicMutex::isRecursive() const Q_DECL_NOTHROW
{