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/qiterator.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/qiterator.qdoc')
| -rw-r--r-- | src/corelib/tools/qiterator.qdoc | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/corelib/tools/qiterator.qdoc b/src/corelib/tools/qiterator.qdoc index 25914967a9..1ae9c58daa 100644 --- a/src/corelib/tools/qiterator.qdoc +++ b/src/corelib/tools/qiterator.qdoc @@ -580,9 +580,9 @@ \fn bool QMutableVectorIterator::hasNext() const \fn bool QMutableSetIterator::hasNext() const - Returns true if there is at least one item ahead of the iterator, + Returns \c true if there is at least one item ahead of the iterator, i.e. the iterator is \e not at the back of the container; - otherwise returns false. + otherwise returns \c false. \sa hasPrevious(), next() */ @@ -649,9 +649,9 @@ \fn bool QMutableVectorIterator::hasPrevious() const \fn bool QMutableSetIterator::hasPrevious() const - Returns true if there is at least one item behind the iterator, + Returns \c true if there is at least one item behind the iterator, i.e. the iterator is \e not at the front of the container; - otherwise returns false. + otherwise returns \c false. \sa hasNext(), previous() */ @@ -720,7 +720,7 @@ \fn bool QMutableSetIterator::findNext(const T &value) Searches for \a value starting from the current iterator position - forward. Returns true if \a value is found; otherwise returns false. + forward. Returns \c true if \a value is found; otherwise returns \c false. After the call, if \a value was found, the iterator is positioned just after the matching item; otherwise, the iterator is @@ -739,7 +739,7 @@ \fn bool QMutableSetIterator::findPrevious(const T &value) Searches for \a value starting from the current iterator position - backward. Returns true if \a value is found; otherwise returns + backward. Returns \c true if \a value is found; otherwise returns false. After the call, if \a value was found, the iterator is positioned @@ -1175,9 +1175,9 @@ \fn bool QMutableMapIterator::hasNext() const \fn bool QMutableHashIterator::hasNext() const - Returns true if there is at least one item ahead of the iterator, + Returns \c true if there is at least one item ahead of the iterator, i.e. the iterator is \e not at the back of the container; - otherwise returns false. + otherwise returns \c false. \sa hasPrevious(), next() */ @@ -1243,9 +1243,9 @@ \fn bool QMutableMapIterator::hasPrevious() const \fn bool QMutableHashIterator::hasPrevious() const - Returns true if there is at least one item behind the iterator, + Returns \c true if there is at least one item behind the iterator, i.e. the iterator is \e not at the front of the container; - otherwise returns false. + otherwise returns \c false. \sa hasNext(), previous() */ @@ -1369,8 +1369,8 @@ \fn bool QMutableHashIterator::findNext(const T &value) Searches for \a value starting from the current iterator position - forward. Returns true if a (key, value) pair with value \a value - is found; otherwise returns false. + forward. Returns \c true if a (key, value) pair with value \a value + is found; otherwise returns \c false. After the call, if \a value was found, the iterator is positioned just after the matching item; otherwise, the iterator is @@ -1385,8 +1385,8 @@ \fn bool QMutableHashIterator::findPrevious(const T &value) Searches for \a value starting from the current iterator position - backward. Returns true if a (key, value) pair with value \a value - is found; otherwise returns false. + backward. Returns \c true if a (key, value) pair with value \a value + is found; otherwise returns \c false. After the call, if \a value was found, the iterator is positioned just before the matching item; otherwise, the iterator is |