diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2024-08-07 20:08:37 +0200 |
|---|---|---|
| committer | André Hartmann <aha_1980@gmx.de> | 2024-08-10 15:28:50 +0000 |
| commit | 94f87d6d65f42140dbf58b8c6badd1a4c61c8c76 (patch) | |
| tree | 6cfad6a917f707ba3e2c9fc2fb6c09af361bf376 /src/corelib/kernel/qtimer.cpp | |
| parent | ff339819925ab550c48b53d9baaba43e5adebfaa (diff) | |
Doc: Use consistent terminology in Q(Chrono)Timer's docs
Unify the wording "running" and "active".
"Running" seems more natural, so keep that wording,
and replace "active" with "running" in API docs.
Pick-to: 6.8
Change-Id: I300f530d1cfe789f74ed32f57afe9388f2127ead
Reviewed-by: Ahmad Samir <a.samirh78@gmail.com>
Diffstat (limited to 'src/corelib/kernel/qtimer.cpp')
| -rw-r--r-- | src/corelib/kernel/qtimer.cpp | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/corelib/kernel/qtimer.cpp b/src/corelib/kernel/qtimer.cpp index c51988970be..9703d810ee9 100644 --- a/src/corelib/kernel/qtimer.cpp +++ b/src/corelib/kernel/qtimer.cpp @@ -161,8 +161,7 @@ QTimer::~QTimer() /*! \fn bool QTimer::isActive() const - Returns \c true if the timer is running (pending); otherwise returns - false. + Returns \c true if the timer is running; otherwise returns \c false. */ bool QTimer::isActive() const { @@ -551,7 +550,7 @@ void QTimer::singleShot(std::chrono::milliseconds msec, Qt::TimerType timerType, Returns the time remaining in this timer object as a \c std::chrono::milliseconds object. If this timer is due or overdue, the returned value is \c std::chrono::milliseconds::zero(). If the remaining - time could not be found or the timer is not active, this function returns a + time could not be found or the timer is not running, this function returns a negative duration. \sa remainingTime() @@ -591,9 +590,9 @@ QBindable<bool> QTimer::bindableSingleShot() interval of 0 will time out as soon as all the events in the window system's event queue have been processed. - Setting the interval of an active timer will change the interval, + Setting the interval of a running timer will change the interval, stop() and then start() the timer, and acquire a new id(). - If the timer is not active, only the interval is changed. + If the timer is not running, only the interval is changed. \sa singleShot */ |