From 657bea873b9bf66764848d612b4188039ec7e583 Mon Sep 17 00:00:00 2001
From: Nico Vertriest <nico.vertriest@qt.io>
Date: Wed, 25 Jan 2017 15:20:26 +0100
Subject: [PATCH] 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 <Venugopal.Shivashankar@qt.io>
---
 src/corelib/thread/qmutex.cpp | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/corelib/thread/qmutex.cpp b/src/corelib/thread/qmutex.cpp
index b9b16e066f6..29095f8b51e 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
 
+    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().