summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAleix Pol <aleixpol@kde.org>2020-03-14 02:34:11 +0100
committerAleix Pol <aleixpol@kde.org>2020-12-05 04:14:44 +0100
commit302254f90f41509b3d1111551296134cd76a3db5 (patch)
tree83312f6c995c8990e32f46e76181d2e694658d92 /src
parent105a66e6543467863a39cd12271f125b45d74179 (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>
Diffstat (limited to 'src')
-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 4201e37c0b6..2f7b50ed841 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.