From 816ca43b88893e06ea866c3edadd0ca26f64b533 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 28 Mar 2023 07:30:24 +0000 Subject: [PATCH] Doc: Use \relates for functions in the global scope This addresses the recent warnings introduced by a change to QDoc: qkeysequence.h:32: (qdoc) warning: No documentation generated for function 'qHash' in global scope. qmap.h:1557: (qdoc) warning: No documentation generated for function 'operator+' in global scope. qmap.h:1565: (qdoc) warning: No documentation generated for function 'operator+=' in global scope. qvariant.h:582: (qdoc) warning: No documentation generated for function 'operator>>' in global scope. qvariant.h:590: (qdoc) warning: No documentation generated for function 'operator<<' in global scope. Also, mark qt_win_hasPackageIdentity() declared in qfunctions_win_p.h as \internal. Pick-to: 6.5 Change-Id: Idc9c813370ff3133ac9dc3bf809976b0ece88811 Reviewed-by: Paul Wicking --- src/corelib/kernel/qfunctions_win.cpp | 1 + src/corelib/kernel/qvariant.cpp | 2 ++ src/corelib/tools/qmultimap.qdoc | 2 ++ src/gui/kernel/qkeysequence.cpp | 1 + 4 files changed, 6 insertions(+) diff --git a/src/corelib/kernel/qfunctions_win.cpp b/src/corelib/kernel/qfunctions_win.cpp index ed0e25467c2..d5ce3e58944 100644 --- a/src/corelib/kernel/qfunctions_win.cpp +++ b/src/corelib/kernel/qfunctions_win.cpp @@ -33,6 +33,7 @@ QComHelper::~QComHelper() } /*! + \internal Checks if the application has a \e{package identity} Having a \e{package identity} is required to use many modern diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp index d799487d3cc..28761f97921 100644 --- a/src/corelib/kernel/qvariant.cpp +++ b/src/corelib/kernel/qvariant.cpp @@ -1294,12 +1294,14 @@ QDataStream &operator<<(QDataStream &s, const QVariant &p) } /*! \fn QDataStream& operator>>(QDataStream &s, QVariant::Type &p) + \relates QVariant \deprecated [6.0] Stream QMetaType::Type instead. Reads a variant type \a p in enum representation from the stream \a s. */ /*! \fn QDataStream& operator<<(QDataStream &s, const QVariant::Type p) + \relates QVariant \deprecated [6.0] Stream QMetaType::Type instead. Writes a variant type \a p to the stream \a s. diff --git a/src/corelib/tools/qmultimap.qdoc b/src/corelib/tools/qmultimap.qdoc index c4b073bd949..45af5b9ec9f 100644 --- a/src/corelib/tools/qmultimap.qdoc +++ b/src/corelib/tools/qmultimap.qdoc @@ -959,6 +959,7 @@ */ /*! \fn template QMultiMap operator+=(QMultiMap &lhs, const QMultiMap &rhs) + \relates QMultiMap Inserts all the items in the \a rhs map into the \a lhs map and returns the resulting map. @@ -967,6 +968,7 @@ */ /*! \fn template QMultiMap operator+(const QMultiMap &lhs, const QMultiMap &rhs) + \relates QMultiMap Returns a map that contains all the items in the \a lhs map in addition to all the items in \a rhs. If a key is common to both diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp index 0e05eb3375c..cd7256a5fba 100644 --- a/src/gui/kernel/qkeysequence.cpp +++ b/src/gui/kernel/qkeysequence.cpp @@ -1427,6 +1427,7 @@ bool QKeySequence::operator==(const QKeySequence &other) const /*! \since 5.6 + \relates QKeySequence Calculates the hash value of \a key, using \a seed to seed the calculation.