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/qcontiguouscache.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/qcontiguouscache.cpp')
| -rw-r--r-- | src/corelib/tools/qcontiguouscache.cpp | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/corelib/tools/qcontiguouscache.cpp b/src/corelib/tools/qcontiguouscache.cpp index 6ccdb7b771..e284ce1e5d 100644 --- a/src/corelib/tools/qcontiguouscache.cpp +++ b/src/corelib/tools/qcontiguouscache.cpp @@ -219,7 +219,7 @@ MyRecord record(int row) const /*! \fn bool QContiguousCache::operator==(const QContiguousCache<T> &other) const - Returns true if \a other is equal to this cache; otherwise returns false. + Returns \c true if \a other is equal to this cache; otherwise returns \c false. Two caches are considered equal if they contain the same values at the same indexes. This function requires the value type to implement the \c operator==(). @@ -229,8 +229,8 @@ MyRecord record(int row) const /*! \fn bool QContiguousCache::operator!=(const QContiguousCache<T> &other) const - Returns true if \a other is not equal to this cache; otherwise - returns false. + Returns \c true if \a other is not equal to this cache; otherwise + returns \c false. Two caches are considered equal if they contain the same values at the same indexes. This function requires the value type to implement the \c operator==(). @@ -261,14 +261,14 @@ MyRecord record(int row) const /*! \fn bool QContiguousCache::isEmpty() const - Returns true if no items are stored within the cache. + Returns \c true if no items are stored within the cache. \sa size(), capacity() */ /*! \fn bool QContiguousCache::isFull() const - Returns true if the number of items stored within the cache is equal + Returns \c true if the number of items stored within the cache is equal to the capacity of the cache. \sa size(), capacity() @@ -373,7 +373,7 @@ MyRecord record(int row) const /*! \fn bool QContiguousCache::containsIndex(int i) const - Returns true if the cache's index range includes the given index \a i. + Returns \c true if the cache's index range includes the given index \a i. \sa firstIndex(), lastIndex() */ |