AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix documentation of QPartialOrdering

Browse Source 
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>
This commit is contained in:
Andreas Buhr 2020-12-01 13:00:44 +01:00 committed by Volker Hilsheimer
parent 80b7ef559a
commit c4d488eeb9
1 changed files with 6 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/corelib/global/qcompare.qdoc
View File

@ -80,16 +80,14 @@
*/
/*!
\fn bool operator==(QPartialOrdering p1, QPartialOrdering p2) noexcept
\relates QPartialOrdering
\fn bool QPartialOrdering::operator==(QPartialOrdering p1, QPartialOrdering p2) noexcept
Return true if \a p1 and \a p2 represent the same result;
otherwise, returns false.
*/
/*!
\fn bool operator!=(QPartialOrdering p1, QPartialOrdering p2) noexcept
\relates QPartialOrdering
\fn bool QPartialOrdering::operator!=(QPartialOrdering p1, QPartialOrdering p2) noexcept
Return true if \a p1 and \a p2 represent different results;
otherwise, returns true.
@ -114,33 +112,25 @@
*/
/*!
\value QPartialOrdering::Less
\relates QPartialOrdering
\variable QPartialOrdering::Less
Represents the result of a comparison where the value on the left
hand side is less than the value on right hand side.
*/
/*!
\value QPartialOrdering::Equivalent
\relates QPartialOrdering
\variable QPartialOrdering::Equivalent
Represents the result of a comparison where the value on the left
hand side is equivalent to the value on right hand side.
*/
/*!
\value QPartialOrdering::Greater
\relates QPartialOrdering
\variable QPartialOrdering::Greater
Represents the result of a comparison where the value on the left
hand side is greater than the value on right hand side.
*/
/*!
\value QPartialOrdering::Unordered
\relates QPartialOrdering
\variable QPartialOrdering::Unordered
Represents the result of a comparison where the value on the left
hand side is not ordered with respect to the value on right hand
side.