summaryrefslogtreecommitdiffstats
path: root/src/corelib/global/qcompare.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Fix documentation of QPartialOrderingAndreas Buhr2020-12-011-16/+6
| | | | | | | | | | | | | | | | qdoc did not find the hidden friend comparison functions at gave errors like qcompare.qdoc:82: (qdoc) warning: clang couldn't find function when parsing \fn bool operator==(QPartialOrdering p1, QPartialOrdering p2) noexcept This patch documents them as if they were class members to fix this. Document the constants as \variables. Task-number: QTBUG-88533 Pick-to: 6.0 Change-Id: Ife56f16894e454f324060aeb73f66aba2d45e530 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix QVariant/QMetaType::compare APIsGiuseppe D'Angelo2020-11-301-0/+147
std::optional<int> is the wrong datatype to use for compare. First and foremost, it can't be used in the idiomatic form of auto r = a.compare(b); if (r < 0) ~~~ // a is less than b if (r > 0) ~~~ // a is greater than b which we *already* feature in Qt (QString, QByteArray). Also, std::optional<int> (explicitly) converts to bool, which is a trap, because the result of the comparison can be accidentally tested as a bool: if (a.compare(b)) ~~~ // oops! does NOT mean a<b Not to mention extending this to algorithms: auto lessThan = [](QVariant a, QVariant b) { return a.compare(b); }; // oops! std::ranges::sort(vectorOfVariants, lessThan); which thankfully doesn't compile as is -- std::optional has an *explicit* operator bool, and the Compare concept requires an implicit conversion. However, the error the user is going to face will be "cannot convert to bool because the operator is explicit", which is deceiving because the fix is NOT supposed to be: auto lessThan = [](QVariant a, QVariant b) { return (bool)a.compare(b); }; // big oops! Instead: backport to Qt the required subset of C++20's <compare> API, and use that. This commits just adds the necessary parts for compare() (i.e. partial ordering), the rest of <compare> (classes, functions, conversions) can be added to 6.1. Change-Id: I2b5522da47854da39f79993e1207fad033786f00 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> (cherry picked from commit 3e59c97c3453926fc66479d9ceca03901df55f90) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>