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

Doc: Fix undocumented parameter in QFlags::operator=()

Browse Source 
Fixes a documentation warning:
  (qdoc) warning: Undocumented parameter 'other' in QFlags::operator=()

This warning is reported by the latest version of QDoc, but fixing
it causes another warning in the currently-provisioned QDoc.
Therefore, raise the warning limit temporarily to pass the
documentation check in CI.

Change-Id: I14863baebf712cda6f4da6d989e3ab83ffea7f85
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit d76828a1c73ecb5858142f63bea4bb4ea8bf2a25)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Topi Reinio 2024-01-31 12:05:04 +00:00 committed by Qt Cherry-pick Bot
parent 482962ffca
commit 2e5a5e23fc
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/corelib/doc/qtcore.qdocconf
View File

@ -66,5 +66,5 @@ manifestmeta.highlighted.names = \
"QtCore/Serialization Converter" \ "QtCore/Serialization Converter" \
"QtCore/QXmlStream Bookmarks Example" "QtCore/QXmlStream Bookmarks Example"
# Enforce zero documentation warnings # Temporarily allow warning: No such parameter 'other' in QFlags::operator=()
warninglimit = 0 warninglimit = 1

2
src/corelib/global/qflags.qdoc
View File

@ -174,7 +174,7 @@
/*! /*!
\fn template <typename Enum> QFlags &QFlags<Enum>::operator=(const QFlags &other) \fn template <typename Enum> QFlags &QFlags<Enum>::operator=(const QFlags &other)
Assigns \e other to this object and returns a reference to this Assigns \a other to this object and returns a reference to this
object. object.
*/ */