summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAndreas Buhr <andreas@andreasbuhr.de>2020-12-03 11:02:51 +0100
committerAndreas Buhr <andreas@andreasbuhr.de>2020-12-03 20:21:34 +0100
commit15cd7d774146ed18f537a79f44e5ca3401c72c38 (patch)
tree6f68b82440057882d31c63c03a7f45938f9dd6f7 /src
parente32e4898dde1dc2a5ae19a1c3dc4609064258a43 (diff)
Fix documentation warnings about QCollator property
The documentation of ignorePunctuation in QCollator did not strictly follow conventions, leading to warnings in building the documentation. This patch fixes this. Task-number: QTBUG-88533 Pick-to: 6.0 Change-Id: Ia1273ec8e440099afe729b54423760ad5ac26290 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src')
-rw-r--r--src/corelib/text/qcollator.cpp4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/corelib/text/qcollator.cpp b/src/corelib/text/qcollator.cpp
index 46bd64daf51..d1bf8258aeb 100644
--- a/src/corelib/text/qcollator.cpp
+++ b/src/corelib/text/qcollator.cpp
@@ -268,7 +268,7 @@ bool QCollator::numericMode() const
}
/*!
- Control whether punctuation and symbols are ignored when collating.
+ Ignores punctuation and symbols if \a on is \c true, attends to them if \c false.
\sa ignorePunctuation()
*/
@@ -282,7 +282,7 @@ void QCollator::setIgnorePunctuation(bool on)
}
/*!
- Indicates whether punctuation and symbols are ignored when collating.
+ Returns whether punctuation and symbols are ignored when collating.
When \c true, strings are compared as if all punctuation and symbols were
removed from each string.