summaryrefslogtreecommitdiffstats
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:11 +0000
commitf35dd8ea143f251659f7bc96d12f1da5d76837b6 (patch)
treef6ef906894a8b17babedba4d4b3a9e445c28dc1e
parent288d27e9f1d9aa1523b69cb39577620556c11e4b (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>
-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 fe959e3c94..5a93735c49 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.