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/gui/kernel/qpalette.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/gui/kernel/qpalette.cpp')
-rw-r--r-- | src/gui/kernel/qpalette.cpp | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp index 00ab74e4e4..f284c20af5 100644 --- a/src/gui/kernel/qpalette.cpp +++ b/src/gui/kernel/qpalette.cpp @@ -763,8 +763,8 @@ void QPalette::setBrush(ColorGroup cg, ColorRole cr, const QBrush &b) /*! \since 4.2 - Returns true if the ColorGroup \a cg and ColorRole \a cr has been - set previously on this palette; otherwise returns false. + Returns \c true if the ColorGroup \a cg and ColorRole \a cr has been + set previously on this palette; otherwise returns \c false. \sa setBrush() */ @@ -795,8 +795,8 @@ void QPalette::detach() /*! \fn bool QPalette::operator!=(const QPalette &p) const - Returns true (slowly) if this palette is different from \a p; - otherwise returns false (usually quickly). + Returns \c true (slowly) if this palette is different from \a p; + otherwise returns \c false (usually quickly). \note The current ColorGroup is not taken into account when comparing palettes @@ -805,8 +805,8 @@ void QPalette::detach() */ /*! - Returns true (usually quickly) if this palette is equal to \a p; - otherwise returns false (slowly). + Returns \c true (usually quickly) if this palette is equal to \a p; + otherwise returns \c false (slowly). \note The current ColorGroup is not taken into account when comparing palettes @@ -829,8 +829,8 @@ bool QPalette::operator==(const QPalette &p) const /*! \fn bool QPalette::isEqual(ColorGroup cg1, ColorGroup cg2) const - Returns true (usually quickly) if color group \a cg1 is equal to - \a cg2; otherwise returns false. + Returns \c true (usually quickly) if color group \a cg1 is equal to + \a cg2; otherwise returns \c false. */ bool QPalette::isEqual(QPalette::ColorGroup group1, QPalette::ColorGroup group2) const { @@ -1010,9 +1010,9 @@ QDataStream &operator>>(QDataStream &s, QPalette &p) #endif //QT_NO_DATASTREAM /*! - Returns true if this palette and \a p are copies of each other, + Returns \c true if this palette and \a p are copies of each other, i.e. one of them was created as a copy of the other and neither - was subsequently modified; otherwise returns false. This is much + was subsequently modified; otherwise returns \c false. This is much stricter than equality. \sa operator=(), operator==() |