From 46b8da642b9016c84d0cba12dab9bae3fba24ae4 Mon Sep 17 00:00:00 2001 From: Ahmad Samir Date: Sat, 3 Aug 2024 03:46:21 +0300 Subject: [PATCH] Q{Chrono,}Timer: de-duplicate API docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pick-to: 6.8 Change-Id: Ib88d89e5f8dae4a834467c05e2e5fa6983e7cd76 Reviewed-by: André Hartmann --- src/corelib/kernel/qchronotimer.cpp | 2 ++ src/corelib/kernel/qtimer.cpp | 18 ++++++++++-------- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/src/corelib/kernel/qchronotimer.cpp b/src/corelib/kernel/qchronotimer.cpp index 0224b3328b6..20594aee52a 100644 --- a/src/corelib/kernel/qchronotimer.cpp +++ b/src/corelib/kernel/qchronotimer.cpp @@ -181,8 +181,10 @@ Qt::TimerId QChronoTimer::id() const Starts or restarts the timer with the timeout specified in \l interval. +//! [stop-restart-timer] If the timer is already running, it will be \l{QChronoTimer::stop()}{stopped} and restarted. +//! [stop-restart-timer] If \l singleShot is true, the timer will be activated only once. */ diff --git a/src/corelib/kernel/qtimer.cpp b/src/corelib/kernel/qtimer.cpp index 362285e3694..f2311363781 100644 --- a/src/corelib/kernel/qtimer.cpp +++ b/src/corelib/kernel/qtimer.cpp @@ -202,10 +202,14 @@ Qt::TimerId QTimer::id() const Starts or restarts the timer with the timeout specified in \l interval. +//! [stop-restart-timer] If the timer is already running, it will be \l{QTimer::stop()}{stopped} and restarted. +//! [stop-restart-timer] +//! [singleshot-activation] If \l singleShot is true, the timer will be activated only once. +//! [singleshot-activation] */ void QTimer::start() { @@ -224,11 +228,10 @@ void QTimer::start() Starts or restarts the timer with a timeout interval of \a msec milliseconds. - If the timer is already running, it will be - \l{QTimer::stop()}{stopped} and restarted. + \include qtimer.cpp stop-restart-timer - If \l singleShot is true, the timer will be activated only once. This is - equivalent to: + \include qtimer.cpp singleshot-activation + This is equivalent to: \code timer.setInterval(msec); @@ -521,11 +524,10 @@ void QTimer::singleShot(std::chrono::milliseconds msec, Qt::TimerType timerType, Starts or restarts the timer with a timeout of duration \a msec milliseconds. - If the timer is already running, it will be - \l{QTimer::stop()}{stopped} and restarted. + \include qtimer.cpp stop-restart-timer - If \l singleShot is true, the timer will be activated only once. This is - equivalent to: + \include qtimer.cpp singleshot-activation + This is equivalent to: \code timer.setInterval(msec);