From ba8c34aaf3683d1502e78ad7a6af700efdeaf0f9 Mon Sep 17 00:00:00 2001 From: Lars Knoll Date: Wed, 11 Mar 2015 15:37:11 +0100 Subject: 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 --- src/corelib/tools/qcollator.cpp | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'src/corelib/tools/qcollator.cpp') 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 -- cgit v1.2.3