summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qcollator.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/corelib/tools/qcollator.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/corelib/tools/qcollator.cpp')
-rw-r--r--src/corelib/tools/qcollator.cpp8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/corelib/tools/qcollator.cpp b/src/corelib/tools/qcollator.cpp
index 7d5915a1cb..a3a9ef940b 100644
--- a/src/corelib/tools/qcollator.cpp
+++ b/src/corelib/tools/qcollator.cpp
@@ -184,7 +184,7 @@ QLocale QCollator::locale() const
/*!
\fn bool QCollator::numericMode() const
- Returns true if numeric sorting is enabled, false otherwise.
+ Returns \c true if numeric sorting is enabled, false otherwise.
\sa setNumericMode()
*/
@@ -202,7 +202,7 @@ QLocale QCollator::locale() const
/*!
\fn bool QCollator::ignorePunctuation() const
- Returns true if punctuation characters and symbols are ignored when determining sort order.
+ Returns \c true if punctuation characters and symbols are ignored when determining sort order.
\sa setIgnorePunctuation()
*/
@@ -303,8 +303,8 @@ QCollatorSortKey& QCollatorSortKey::operator=(const QCollatorSortKey &other)
/*!
\fn bool QCollatorSortKey::operator<(const QCollatorSortKey &otherKey) const
- According to the QCollator that created the key, returns true if the
- key should be sorted before than \a otherKey; otherwise returns false.
+ According to the QCollator that created the key, returns \c true if the
+ key should be sorted before than \a otherKey; otherwise returns \c false.
\sa compare()
*/