summaryrefslogtreecommitdiffstats
path: root/src/plugins/imageformats/ico
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/plugins/imageformats/ico
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/plugins/imageformats/ico')
-rw-r--r--src/plugins/imageformats/ico/qicohandler.cpp4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/plugins/imageformats/ico/qicohandler.cpp b/src/plugins/imageformats/ico/qicohandler.cpp
index b1a674365d..77bb727a51 100644
--- a/src/plugins/imageformats/ico/qicohandler.cpp
+++ b/src/plugins/imageformats/ico/qicohandler.cpp
@@ -629,8 +629,8 @@ QList<QImage> ICOReader::read(QIODevice * device)
/*!
Writes all the QImages in the \a images list to the given \a
- device. Returns true if the images are written successfully;
- otherwise returns false.
+ device. Returns \c true if the images are written successfully;
+ otherwise returns \c false.
The first image in the list is stored as the first icon in the
device, and is therefore used as the default icon by applications.