From 2e5a5e23fca886159cf7de9e810ec503d65f1bf7 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 31 Jan 2024 12:05:04 +0000 Subject: [PATCH] Doc: Fix undocumented parameter in QFlags::operator=() MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ö (cherry picked from commit d76828a1c73ecb5858142f63bea4bb4ea8bf2a25) Reviewed-by: Qt Cherry-pick Bot --- src/corelib/doc/qtcore.qdocconf | 4 ++-- src/corelib/global/qflags.qdoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/corelib/doc/qtcore.qdocconf b/src/corelib/doc/qtcore.qdocconf index 9451c666565..4ed46ae6ddb 100644 --- a/src/corelib/doc/qtcore.qdocconf +++ b/src/corelib/doc/qtcore.qdocconf @@ -66,5 +66,5 @@ manifestmeta.highlighted.names = \ "QtCore/Serialization Converter" \ "QtCore/QXmlStream Bookmarks Example" -# Enforce zero documentation warnings -warninglimit = 0 +# Temporarily allow warning: No such parameter 'other' in QFlags::operator=() +warninglimit = 1 diff --git a/src/corelib/global/qflags.qdoc b/src/corelib/global/qflags.qdoc index 4542d99268a..598576bfe6b 100644 --- a/src/corelib/global/qflags.qdoc +++ b/src/corelib/global/qflags.qdoc @@ -174,7 +174,7 @@ /*! \fn template QFlags &QFlags::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. */