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/qpair.qdoc | |
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/qpair.qdoc')
-rw-r--r-- | src/corelib/tools/qpair.qdoc | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/corelib/tools/qpair.qdoc b/src/corelib/tools/qpair.qdoc index dd3df8c464..be329a0df0 100644 --- a/src/corelib/tools/qpair.qdoc +++ b/src/corelib/tools/qpair.qdoc @@ -120,7 +120,7 @@ \relates QPair - Returns true if \a p1 is equal to \a p2; otherwise returns false. + Returns \c true if \a p1 is equal to \a p2; otherwise returns \c false. Two pairs compare equal if their \c first data members compare equal and if their \c second data members compare equal. @@ -132,7 +132,7 @@ \relates QPair - Returns true if \a p1 is not equal to \a p2; otherwise returns + Returns \c true if \a p1 is not equal to \a p2; otherwise returns false. Two pairs compare as not equal if their \c first data members are not equal or if their \c second data members are not equal. @@ -145,7 +145,7 @@ \relates QPair - Returns true if \a p1 is less than \a p2; otherwise returns + Returns \c true if \a p1 is less than \a p2; otherwise returns false. The comparison is done on the \c first members of \a p1 and \a p2; if they compare equal, the \c second members are compared to break the tie. @@ -158,7 +158,7 @@ \relates QPair - Returns true if \a p1 is greater than \a p2; otherwise returns + Returns \c true if \a p1 is greater than \a p2; otherwise returns false. The comparison is done on the \c first members of \a p1 and \a p2; if they compare equal, the \c second members are compared to break the tie. @@ -171,8 +171,8 @@ \relates QPair - Returns true if \a p1 is less than or equal to \a p2; otherwise - returns false. The comparison is done on the \c first members of + Returns \c true if \a p1 is less than or equal to \a p2; otherwise + returns \c false. The comparison is done on the \c first members of \a p1 and \a p2; if they compare equal, the \c second members are compared to break the tie. @@ -184,8 +184,8 @@ \relates QPair - Returns true if \a p1 is greater than or equal to \a p2; - otherwise returns false. The comparison is done on the \c first + Returns \c true if \a p1 is greater than or equal to \a p2; + otherwise returns \c false. The comparison is done on the \c first members of \a p1 and \a p2; if they compare equal, the \c second members are compared to break the tie. |