diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-03-28 07:30:24 +0000 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2023-03-28 21:13:07 +0000 |
| commit | 816ca43b88893e06ea866c3edadd0ca26f64b533 (patch) | |
| tree | eb4d1e52d88d5a80bffb1d0b9bac513013d24fe1 /src | |
| parent | f177a3483618ff2df4006cc05503edf248a4df05 (diff) | |
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 <paul.wicking@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/corelib/kernel/qfunctions_win.cpp | 1 | ||||
| -rw-r--r-- | src/corelib/kernel/qvariant.cpp | 2 | ||||
| -rw-r--r-- | src/corelib/tools/qmultimap.qdoc | 2 | ||||
| -rw-r--r-- | src/gui/kernel/qkeysequence.cpp | 1 |
4 files changed, 6 insertions, 0 deletions
diff --git a/src/corelib/kernel/qfunctions_win.cpp b/src/corelib/kernel/qfunctions_win.cpp index ed0e25467c..d5ce3e5894 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 d799487d3c..28761f9792 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 c4b073bd94..45af5b9ec9 100644 --- a/src/corelib/tools/qmultimap.qdoc +++ b/src/corelib/tools/qmultimap.qdoc @@ -959,6 +959,7 @@ */ /*! \fn template <class Key, class T> QMultiMap<Key, T> operator+=(QMultiMap<Key, T> &lhs, const QMultiMap<Key, T> &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 <class Key, class T> QMultiMap<Key, T> operator+(const QMultiMap<Key, T> &lhs, const QMultiMap<Key, T> &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 0e05eb3375..cd7256a5fb 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. |