summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel
diff options
context:
space:
mode:
authorAleix Pol <aleixpol@kde.org>2020-03-14 02:34:11 +0100
committerGiuseppe D'Angelo <giuseppe.dangelo@kdab.com>2020-12-05 13:30:02 +0000
commit07b6b25c4c123640c6ed65ce5d68cec46c6281c1 (patch)
tree38601b6e0c36134dc8b39198b20d7516905b5d6b /src/corelib/kernel
parentca389cdecffd821570e8e569e2d4c082ea586d99 (diff)
Improve the documentation for QElapsedTimer::restart, include units
Specify that QElapsedTimer::restart returns milliseconds Change-Id: I47d9ffde7b0f73c30b14d2ce8467ec0a553b58f8 Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 302254f90f41509b3d1111551296134cd76a3db5) Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Diffstat (limited to 'src/corelib/kernel')
-rw-r--r--src/corelib/kernel/qelapsedtimer_generic.cpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/corelib/kernel/qelapsedtimer_generic.cpp b/src/corelib/kernel/qelapsedtimer_generic.cpp
index 4201e37c0b..2f7b50ed84 100644
--- a/src/corelib/kernel/qelapsedtimer_generic.cpp
+++ b/src/corelib/kernel/qelapsedtimer_generic.cpp
@@ -81,7 +81,8 @@ void QElapsedTimer::start() noexcept
}
/*!
- Restarts the timer and returns the time elapsed since the previous start.
+ Restarts the timer and returns the number of milliseconds elapsed since
+ the previous start.
This function is equivalent to obtaining the elapsed time with elapsed()
and then starting the timer again with start(), but it does so in one
single operation, avoiding the need to obtain the clock value twice.