Doc: added info about return type for function QMutex::try_lock()

qmutex.cpp:266: warning: Undocumented return value Change-Id: Ib93a5a2505f663f266871dbe5582fb5856096889 Reviewed-by: Venugopal Shivashankar <[email protected]>
praveenmunagapati · Feb 28, 2017 · 657bea8 · 657bea8
1 parent 4a31eca
commit 657bea8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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
 
+    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().