1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation of Qt ordering types

Browse Source 
Apply some documentation improvements that were suggested before FF.

Task-number: QTBUG-119433
Change-Id: I9b1d83c69821e25ae4cd8db0cbf3fa6d6330a6dc
Reviewed-by: Dennis Oberst <dennis.oberst@qt.io>
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
(cherry picked from commit aae6cf8d15837c9a29503d5fdeceb2a4b5befc55)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Ivan Solovev 2023-12-19 12:12:15 +01:00 committed by Qt Cherry-pick Bot
parent 267a34e490
commit 1b5211a542
1 changed files with 40 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
src/corelib/global/qcompare.cpp
View File

@ -156,16 +156,16 @@ CHECK(strong, equivalent);
A value of type Qt::strong_ordering is typically returned from a three-way A value of type Qt::strong_ordering is typically returned from a three-way
comparison function. Such a function compares two objects and establishes comparison function. Such a function compares two objects and establishes
that the two objects are in a strict ordering relationship; that is, the how they are ordered. It uses this return type to indicate that the ordering
function establishes a well-defined total order. is strict; that is, the function establishes a well-defined total order.
The possible values of type Qt::strong_ordering are fully represented by the Qt::strong_ordering has four values, represented by the following symbolic
following four symbolic constants: constants:
\list \list
\li \l less represents that the left operand is less than the right; \li \l less represents that the left operand is less than the right;
\li \l equal represents that the left operand is equivalent to the right; \li \l equal represents that the left operand is equivalent to the right;
\li \l equivalent is an alias for \c Equal; \li \l equivalent is an alias for \c equal;
\li \l greater represents that the left operand is greater than the right. \li \l greater represents that the left operand is greater than the right.
\endlist \endlist
@ -341,10 +341,11 @@ CHECK(strong, equivalent);
A value of type Qt::weak_ordering is typically returned from a three-way A value of type Qt::weak_ordering is typically returned from a three-way
comparison function. Such a function compares two objects and establishes comparison function. Such a function compares two objects and establishes
the order of the elements relative to each other. how they are ordered. It uses this return type to indicate that the ordering
is weak; that is, equivalent values may be distinguishable.
The possible values of type Qt::weak_ordering are fully represented by the Qt::weak_ordering has three values, represented by the following symbolic
following three symbolic constants: constants:
\list \list
\li \l less represents that the left operand is less than the right; \li \l less represents that the left operand is less than the right;
@ -489,21 +490,19 @@ CHECK(strong, equivalent);
\since 6.7 \since 6.7
A value of type Qt::partial_ordering is typically returned from a A value of type Qt::partial_ordering is typically returned from a
three-way comparison function. Such a function compares two three-way comparison function. Such a function compares two objects,
objects, and it may either establish that the two objects are establishing whether they are ordered and, if so, their ordering. It uses
ordered relative to each other, or that they are not ordered. The this return type to indicate that the ordering is partial; that is, not all
Qt::partial_ordering value returned from the comparison function pairs of values are ordered.
represents one of those possibilities.
The possible values of type Qt::partial_ordering are, in fact, fully Qt::partial_ordering has four values, represented by the following symbolic
represented by the following four symbolic constants: constants:
\list \list
\li \l less represents that the left operand is less than the right; \li \l less represents that the left operand is less than the right;
\li \l equivalent represents that left operand is equivalent to the right; \li \l equivalent represents that the two operands are equivalent;
\li \l greater represents that the left operand is greater than the right; \li \l greater represents that the left operand is greater than the right;
\li \l unordered represents that the left operand is \e {not ordered} with \li \l unordered represents that the two operands are \e {not ordered}.
respect to the right operand.
\endlist \endlist
Qt::partial_ordering is idiomatically used by comparing an instance Qt::partial_ordering is idiomatically used by comparing an instance
@ -528,8 +527,8 @@ CHECK(strong, equivalent);
\endcode \endcode
A Qt::partial_ordering value which represents an unordered result will Comparing Qt::partial_ordering::unordered against literal 0 always returns
always return false when compared against literal 0. a \c false result.
*/ */
/*! /*!
@ -615,8 +614,7 @@ CHECK(strong, equivalent);
/*! /*!
\variable Qt::partial_ordering::equivalent \variable Qt::partial_ordering::equivalent
Represents the result of a comparison where the left operand is equivalent Represents the result of a comparison where the two operands are equivalent.
to the right operand.
*/ */
/*! /*!
@ -629,8 +627,8 @@ CHECK(strong, equivalent);
/*! /*!
\variable Qt::partial_ordering::unordered \variable Qt::partial_ordering::unordered
Represents the result of a comparison where the left operand is not ordered Represents the result of a comparison where there is no ordering
with respect to the right operand. relationship between the two operands.
*/ */
/*! /*!
@ -642,21 +640,19 @@ CHECK(strong, equivalent);
\since 6.0 \since 6.0
A value of type QPartialOrdering is typically returned from a A value of type QPartialOrdering is typically returned from a
three-way comparison function. Such a function compares two three-way comparison function. Such a function compares two objects,
objects, and it may either establish that the two objects are establishing whether they are ordered and, if so, their ordering. It uses
ordered relative to each other, or that they are not ordered. The this return type to indicate that the ordering is partial; that is, not all
QPartialOrdering value returned from the comparison function pairs of values are ordered.
represents one of those possibilities.
The possible values of type QPartialOrdering are, in fact, fully QPartialOrdering has four values, represented by the following symbolic
represented by the following four symbolic constants: constants:
\list \list
\li \c less represents that the left operand is less than the right; \li \l less represents that the left operand is less than the right;
\li \c equivalent represents that left operand is equivalent to the right; \li \l equivalent represents that the two operands are equivalent;
\li \c greater represents that the left operand is greater than the right; \li \l greater represents that the left operand is greater than the right;
\li \c unordered represents that the left operand is \e {not ordered} with \li \l unordered represents that the two operands are \e {not ordered}.
respect to the right operand.
\endlist \endlist
QPartialOrdering is idiomatically used by comparing an instance QPartialOrdering is idiomatically used by comparing an instance
@ -681,8 +677,8 @@ CHECK(strong, equivalent);
\endcode \endcode
A QPartialOrdering value which represents an unordered result will Comparing QPartialOrdering::unordered against literal 0 always returns
always return false when compared against literal 0. a \c false result.
*/ */
/*! /*!
@ -769,8 +765,7 @@ CHECK(strong, equivalent);
/*! /*!
\variable QPartialOrdering::equivalent \variable QPartialOrdering::equivalent
Represents the result of a comparison where the left operand is equivalent Represents the result of a comparison where the two operands are equivalent.
to the right operand.
*/ */
/*! /*!
@ -783,8 +778,8 @@ CHECK(strong, equivalent);
/*! /*!
\variable QPartialOrdering::unordered \variable QPartialOrdering::unordered
Represents the result of a comparison where the left operand is not ordered Represents the result of a comparison where there is no ordering
with respect to the right operand. relationship between the two operands.
*/ */
/*! /*!
@ -797,8 +792,7 @@ CHECK(strong, equivalent);
/*! /*!
\variable QPartialOrdering::Equivalent \variable QPartialOrdering::Equivalent
Represents the result of a comparison where the left operand is equivalent Represents the result of a comparison where the two operands are equivalent.
to the right operand.
*/ */
/*! /*!
@ -811,8 +805,8 @@ CHECK(strong, equivalent);
/*! /*!
\variable QPartialOrdering::Unordered \variable QPartialOrdering::Unordered
Represents the result of a comparison where the left operand is not ordered Represents the result of a comparison where there is no ordering
with respect to the right operand. relationship between the two operands.
*/ */
/*! /*!