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/tools/qelapsedtimer.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/tools/qelapsedtimer.cpp')
-rw-r--r-- | src/corelib/tools/qelapsedtimer.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/corelib/tools/qelapsedtimer.cpp b/src/corelib/tools/qelapsedtimer.cpp index bdca60757f..1da85fce96 100644 --- a/src/corelib/tools/qelapsedtimer.cpp +++ b/src/corelib/tools/qelapsedtimer.cpp @@ -204,13 +204,13 @@ QT_BEGIN_NAMESPACE /*! \fn bool QElapsedTimer::operator ==(const QElapsedTimer &other) const - Returns true if this object and \a other contain the same time. + Returns \c true if this object and \a other contain the same time. */ /*! \fn bool QElapsedTimer::operator !=(const QElapsedTimer &other) const - Returns true if this object and \a other contain different times. + Returns \c true if this object and \a other contain different times. */ static const qint64 invalidData = Q_INT64_C(0x8000000000000000); @@ -230,7 +230,7 @@ void QElapsedTimer::invalidate() Q_DECL_NOTHROW } /*! - Returns false if this object was invalidated by a call to invalidate() and + Returns \c false if this object was invalidated by a call to invalidate() and has not been restarted since. \sa invalidate(), start(), restart() @@ -241,7 +241,7 @@ bool QElapsedTimer::isValid() const Q_DECL_NOTHROW } /*! - Returns true if this QElapsedTimer has already expired by \a timeout + Returns \c true if this QElapsedTimer has already expired by \a timeout milliseconds (that is, more than \a timeout milliseconds have elapsed). The value of \a timeout can be -1 to indicate that this timer does not expire, in which case this function will always return false. |