summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@theqtcompany.com>2015-03-11 15:37:11 +0100
committerLars Knoll <lars.knoll@digia.com>2015-03-18 07:34:26 +0000
commitba8c34aaf3683d1502e78ad7a6af700efdeaf0f9 (patch)
tree95538fee204f43de5ec3660e7d4afdc057aa6a25 /src/corelib/tools
parent75cb6f59f1f55f3494bc601bcafc93fcdce58a19 (diff)
Fix QCollator::compare documentation
We don't guarantee -1, 0 and 1, but simply negative 0 or positive numbers. This is in line with e.g. QString::compare() Task-number: QTBUG-42860 Change-Id: I6009b2eb732ae3b4726cec06ec0eacc2c46a3c93 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/tools')
-rw-r--r--src/corelib/tools/qcollator.cpp13
-rw-r--r--src/corelib/tools/qcollator_posix.cpp3
2 files changed, 8 insertions, 8 deletions
diff --git a/src/corelib/tools/qcollator.cpp b/src/corelib/tools/qcollator.cpp
index f86318c9c9..9148ecf6fc 100644
--- a/src/corelib/tools/qcollator.cpp
+++ b/src/corelib/tools/qcollator.cpp
@@ -275,8 +275,8 @@ bool QCollator::ignorePunctuation() const
/*!
\fn int QCollator::compare(const QString &s1, const QString &s2) const
- Compares \a s1 with \a s2. Returns -1, 0 or 1 depending on whether \a s1 is
- smaller, equal or larger than \a s2.
+ Compares \a s1 with \a s2. Returns an integer less than, equal to, or greater than zero
+ depending on whether \a s1 is smaller, equal or larger than \a s2.
*/
/*!
@@ -288,8 +288,8 @@ bool QCollator::ignorePunctuation() const
\fn int QCollator::compare(const QStringRef &s1, const QStringRef &s2) const
\overload
- Compares \a s1 with \a s2. Returns -1, 0 or 1 depending on whether \a s1 is
- smaller, equal or larger than \a s2.
+ Compares \a s1 with \a s2. Returns an integer less than, equal to, or greater than zero
+ depending on whether \a s1 is smaller, equal or larger than \a s2.
*/
/*!
@@ -299,8 +299,9 @@ bool QCollator::ignorePunctuation() const
Compares \a s1 with \a s2. \a len1 and \a len2 specify the length of the
QChar arrays pointer to by \a s1 and \a s2.
- Returns -1, 0 or 1 depending on whether \a s1 is smaller, equal or larger than \a s2.
- */
+ Returns an integer less than, equal to, or greater than zero
+ depending on whether \a s1 is smaller, equal or larger than \a s2.
+*/
/*!
\fn QCollatorSortKey QCollator::sortKey(const QString &string) const
diff --git a/src/corelib/tools/qcollator_posix.cpp b/src/corelib/tools/qcollator_posix.cpp
index 0b755825b7..352ab0ba31 100644
--- a/src/corelib/tools/qcollator_posix.cpp
+++ b/src/corelib/tools/qcollator_posix.cpp
@@ -78,8 +78,7 @@ int QCollator::compare(const QString &s1, const QString &s2) const
QVarLengthArray<wchar_t> array1, array2;
stringToWCharArray(array1, s1);
stringToWCharArray(array2, s2);
- int result = std::wcscoll(array1.constData(), array2.constData());
- return result > 0 ? 1 : (result == 0 ? 0 : -1);
+ return std::wcscoll(array1.constData(), array2.constData());
}
int QCollator::compare(const QStringRef &s1, const QStringRef &s2) const