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/qcache.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/qcache.qdoc')
-rw-r--r-- | src/corelib/tools/qcache.qdoc | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/corelib/tools/qcache.qdoc b/src/corelib/tools/qcache.qdoc index 4d19d671fd..6d8bf4da59 100644 --- a/src/corelib/tools/qcache.qdoc +++ b/src/corelib/tools/qcache.qdoc @@ -134,8 +134,8 @@ /*! \fn bool QCache::isEmpty() const - Returns true if the cache contains no objects; otherwise - returns false. + Returns \c true if the cache contains no objects; otherwise + returns \c false. \sa size() */ @@ -163,8 +163,8 @@ deleted at any time. In particular, if \a cost is greater than maxCost(), the object will be deleted immediately. - The function returns true if the object was inserted into the - cache; otherwise it returns false. + The function returns \c true if the object was inserted into the + cache; otherwise it returns \c false. \sa take(), remove() */ @@ -182,8 +182,8 @@ /*! \fn bool QCache::contains(const Key &key) const - Returns true if the cache contains an object associated with key \a - key; otherwise returns false. + Returns \c true if the cache contains an object associated with key \a + key; otherwise returns \c false. \sa take(), remove() */ @@ -201,8 +201,8 @@ /*! \fn bool QCache::remove(const Key &key) - Deletes the object associated with key \a key. Returns true if the - object was found in the cache; otherwise returns false. + Deletes the object associated with key \a key. Returns \c true if the + object was found in the cache; otherwise returns \c false. \sa take(), clear() */ |