diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
| commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
| tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/thread/qfuturewatcher.cpp | |
| parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff) | |
Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code.
This commit changes:
-"property is true" to "property is \c true".
-"Returns true" to "Returns \c true".
-"property is false" to "property is \c false".
-"returns true" to "returns \c true".
-"returns false" to "returns \c false".
src/3rdparty and non-documentation instances were ignored.
Task-number: QTBUG-33360
Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/corelib/thread/qfuturewatcher.cpp')
| -rw-r--r-- | src/corelib/thread/qfuturewatcher.cpp | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/corelib/thread/qfuturewatcher.cpp b/src/corelib/thread/qfuturewatcher.cpp index a7f2dd9f73..c986d4e59f 100644 --- a/src/corelib/thread/qfuturewatcher.cpp +++ b/src/corelib/thread/qfuturewatcher.cpp @@ -245,8 +245,8 @@ QString QFutureWatcherBase::progressText() const /*! \fn bool QFutureWatcher::isStarted() const - Returns true if the asynchronous computation represented by the future() - has been started; otherwise returns false. + Returns \c true if the asynchronous computation represented by the future() + has been started; otherwise returns \c false. */ bool QFutureWatcherBase::isStarted() const { @@ -255,8 +255,8 @@ bool QFutureWatcherBase::isStarted() const /*! \fn bool QFutureWatcher::isFinished() const - Returns true if the asynchronous computation represented by the future() - has finished; otherwise returns false. + Returns \c true if the asynchronous computation represented by the future() + has finished; otherwise returns \c false. */ bool QFutureWatcherBase::isFinished() const { @@ -266,8 +266,8 @@ bool QFutureWatcherBase::isFinished() const /*! \fn bool QFutureWatcher::isRunning() const - Returns true if the asynchronous computation represented by the future() - is currently running; otherwise returns false. + Returns \c true if the asynchronous computation represented by the future() + is currently running; otherwise returns \c false. */ bool QFutureWatcherBase::isRunning() const { @@ -276,11 +276,11 @@ bool QFutureWatcherBase::isRunning() const /*! \fn bool QFutureWatcher::isCanceled() const - Returns true if the asynchronous computation has been canceled with the - cancel() function; otherwise returns false. + Returns \c true if the asynchronous computation has been canceled with the + cancel() function; otherwise returns \c false. Be aware that the computation may still be running even though this - function returns true. See cancel() for more details. + function returns \c true. See cancel() for more details. */ bool QFutureWatcherBase::isCanceled() const { @@ -289,11 +289,11 @@ bool QFutureWatcherBase::isCanceled() const /*! \fn bool QFutureWatcher::isPaused() const - Returns true if the asynchronous computation has been paused with the - pause() function; otherwise returns false. + Returns \c true if the asynchronous computation has been paused with the + pause() function; otherwise returns \c false. Be aware that the computation may still be running even though this - function returns true. See setPaused() for more details. + function returns \c true. See setPaused() for more details. \sa setPaused(), togglePaused() */ |