Doc: Fix \fn signatures for QFlags equality operators

These are hidden members, and visible under the QFlags class in the
Clang AST - even though semantically they belong to the parent (global)
scope.

Adjust the \fn signatures accordingly and remove the \relates commands
as unnecessary; QDoc recognizes the `friend` qualifier and marks the
functions as related non-members of QFlags automatically.

Pick-to: 6.9 6.8 6.5
Fixes: QTBUG-133923
Change-Id: Iaca74971bde8b313c573e75688bf57d3ff42b59d
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This commit is contained in:
Topi Reinio 2025-03-28 11:30:12 +00:00
parent 8e98a3a826
commit 39358791f0

View File

@ -430,11 +430,10 @@
*/
/*!
\fn template <typename Enum> bool operator==(QFlags<Enum> lhs, QFlags<Enum> rhs)
\fn template <typename Enum> bool operator==(QFlags<Enum> lhs, Enum rhs)
\fn template <typename Enum> bool operator==(Enum lhs, QFlags<Enum> rhs)
\fn template <typename Enum> bool QFlags<Enum>::operator==(QFlags<Enum> lhs, QFlags<Enum> rhs)
\fn template <typename Enum> bool QFlags<Enum>::operator==(QFlags<Enum> lhs, Enum rhs)
\fn template <typename Enum> bool QFlags<Enum>::operator==(Enum lhs, QFlags<Enum> rhs)
\since 6.2
\relates QFlags
Compares \a lhs and \a rhs for equality; the two arguments are
considered equal if they represent exactly the same value
@ -442,11 +441,10 @@
*/
/*!
\fn template <typename Enum> bool operator!=(QFlags<Enum> lhs, QFlags<Enum> rhs)
\fn template <typename Enum> bool operator!=(QFlags<Enum> lhs, Enum rhs)
\fn template <typename Enum> bool operator!=(Enum lhs, QFlags<Enum> rhs)
\fn template <typename Enum> bool QFlags<Enum>::operator!=(QFlags<Enum> lhs, QFlags<Enum> rhs)
\fn template <typename Enum> bool QFlags<Enum>::operator!=(QFlags<Enum> lhs, Enum rhs)
\fn template <typename Enum> bool QFlags<Enum>::operator!=(Enum lhs, QFlags<Enum> rhs)
\since 6.2
\relates QFlags
Compares \a lhs and \a rhs for inequality; the two arguments are
considered different if they don't represent exactly the same value