From 733bd813283d9bcf6f4dd36bec6633bda1bc7727 Mon Sep 17 00:00:00 2001
From: Fabian Kosmale <fabian.kosmale@qt.io>
Date: Wed, 24 Nov 2021 15:33:03 +0100
Subject: QThread::wait: Clarify documentation for unsigned long overload

It is not immediately clear from the signature that the time parameter's
unit is miliseconds.

Pick-to: 6.2
Change-Id: Ifee3c6410b6b2352e75571cc53578a660aabb32d
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
---
 src/corelib/thread/qthread.cpp | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src/corelib/thread')

diff --git a/src/corelib/thread/qthread.cpp b/src/corelib/thread/qthread.cpp
index 302d34d512..066e9e390a 100644
--- a/src/corelib/thread/qthread.cpp
+++ b/src/corelib/thread/qthread.cpp
@@ -986,7 +986,10 @@ void QThread::setEventDispatcher(QAbstractEventDispatcher *eventDispatcher)
 
 /*!
     \fn bool QThread::wait(unsigned long time)
+
     \overload
+    \a time is the time to wait in milliseconds.
+    If \a time is ULONG_MAX, then the wait will never timeout.
 */
 
 #if QT_CONFIG(thread)
-- 
cgit v1.2.3