1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Use consistent terminology in Q(Chrono)Timer's docs

Browse Source 
Unify the wording "running" and "active".

"Running" seems more natural, so keep that wording,
and replace "active" with "running" in API docs.

Change-Id: I300f530d1cfe789f74ed32f57afe9388f2127ead
Reviewed-by: Ahmad Samir <a.samirh78@gmail.com>
(cherry picked from commit 94f87d6d65f42140dbf58b8c6badd1a4c61c8c76)
This commit is contained in:
Andre Hartmann 2024-08-07 20:08:37 +02:00 committed by Ahmad Samir
parent 04f3381f11
commit bc1011dc36
2 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/corelib/kernel/qchronotimer.cpp
View File

@ -153,8 +153,7 @@ QChronoTimer::~QChronoTimer()
*/
/*!
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 QChronoTimer::isActive() const
{
@ -280,9 +279,9 @@ QBindable<bool> QChronoTimer::bindableSingleShot()
A QChronoTimer with a timeout of \c 0ns 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
*/

9
src/corelib/kernel/qtimer.cpp
View File

@ -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
*/