From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- src/corelib/tools/qcontiguouscache.cpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'src/corelib/tools/qcontiguouscache.cpp') 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 &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 &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() */ -- cgit v1.2.3