From c4d488eeb9f08d48eed76c941ac36b7ab05515ea Mon Sep 17 00:00:00 2001 From: Andreas Buhr Date: Tue, 1 Dec 2020 13:00:44 +0100 Subject: [PATCH] Fix documentation of QPartialOrdering 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 --- src/corelib/global/qcompare.qdoc | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/src/corelib/global/qcompare.qdoc b/src/corelib/global/qcompare.qdoc index 80d402f67c..795e908ecf 100644 --- a/src/corelib/global/qcompare.qdoc +++ b/src/corelib/global/qcompare.qdoc @@ -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.