summaryrefslogtreecommitdiffstats
path: root/src/gui/image/qpixmapcache.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/gui/image/qpixmapcache.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/gui/image/qpixmapcache.cpp')
-rw-r--r--src/gui/image/qpixmapcache.cpp16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/gui/image/qpixmapcache.cpp b/src/gui/image/qpixmapcache.cpp
index f4d2afed7a..dbfe46a455 100644
--- a/src/gui/image/qpixmapcache.cpp
+++ b/src/gui/image/qpixmapcache.cpp
@@ -132,7 +132,7 @@ QPixmapCache::Key::~Key()
/*!
\internal
- Returns true if this key is the same as the given \a key; otherwise returns
+ Returns \c true if this key is the same as the given \a key; otherwise returns
false.
*/
bool QPixmapCache::Key::operator ==(const Key &key) const
@@ -234,7 +234,7 @@ QPMCache::~QPMCache()
the timer is not restarted when the pixmap becomes unused, but it does
restart once something else is added (i.e. the cache space is actually needed).
- Returns true if any were removed.
+ Returns \c true if any were removed.
*/
bool QPMCache::flushDetachedPixmaps(bool nt)
{
@@ -493,7 +493,7 @@ bool QPixmapCache::find(const QString &key, QPixmap& pixmap)
/*!
Looks for a cached pixmap associated with the given \a key in the cache.
If the pixmap is found, the function sets \a pixmap to that pixmap and
- returns true; otherwise it leaves \a pixmap alone and returns false.
+ returns \c true; otherwise it leaves \a pixmap alone and returns \c false.
\since 4.6
@@ -512,7 +512,7 @@ bool QPixmapCache::find(const QString &key, QPixmap* pixmap)
/*!
Looks for a cached pixmap associated with the given \a key in the cache.
If the pixmap is found, the function sets \a pixmap to that pixmap and
- returns true; otherwise it leaves \a pixmap alone and returns false. If
+ returns \c true; otherwise it leaves \a pixmap alone and returns \c false. If
the pixmap is not found, it means that the \a key is no longer valid,
so it will be released for the next insertion.
@@ -543,8 +543,8 @@ bool QPixmapCache::find(const Key &key, QPixmap* pixmap)
The oldest pixmaps (least recently accessed in the cache) are
deleted when more space is needed.
- 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 setCacheLimit()
*/
@@ -576,8 +576,8 @@ QPixmapCache::Key QPixmapCache::insert(const QPixmap &pixmap)
/*!
Replaces the pixmap associated with the given \a key with the \a pixmap
- specified. Returns true if the \a pixmap has been correctly inserted into
- the cache; otherwise returns false.
+ specified. Returns \c true if the \a pixmap has been correctly inserted into
+ the cache; otherwise returns \c false.
\sa setCacheLimit(), insert()