diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-02-14 17:45:45 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-02-25 19:53:27 +0100 |
| commit | 95aec76e3169d37d4d6ba908d8a96ce578cb45e2 (patch) | |
| tree | 752153d17fe1d74bd90f088731d5c7e8b048f3dd /src/corelib/tools/qmap.h | |
| parent | 02e0c30a8aad785343ba1cddba82ccfe59099445 (diff) | |
Doc: Fix documentation warnings for Qt Core
- QCborError: Classes cannot relate to header files; use \inheaderfile
instead and link to the class from header file documentation.
- QRecursiveMutex: QDoc doesn't allow shared documentation comments
for duplicating \fn docs between the base and deriving classes.
Remove the sharing, the function documentation is available under
'All Members' doc for QRecursiveMutex.
- QMultiMap: unite() and one overload of insert() were not recognized
because their definitions in the same header file interfered with
QDoc - use Q_CLANG_QDOC macro to comment them out, and tag \fn
comments to ensure that the function documentation is matched.
Change-Id: Ic96869904a72d92453e4ffa6901000147571969b
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/corelib/tools/qmap.h')
| -rw-r--r-- | src/corelib/tools/qmap.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/corelib/tools/qmap.h b/src/corelib/tools/qmap.h index 2abdc5e60e..427a4ad5a0 100644 --- a/src/corelib/tools/qmap.h +++ b/src/corelib/tools/qmap.h @@ -1115,9 +1115,11 @@ public: inline typename QMap<Key, T>::iterator replace(const Key &key, const T &value) { return QMap<Key, T>::insert(key, value); } typename QMap<Key, T>::iterator insert(const Key &key, const T &value); + //! [qmultimap-insert-pos] typename QMap<Key, T>::iterator insert(typename QMap<Key, T>::const_iterator pos, - const Key &keyi, const T &value); + const Key &key, const T &value); + //! [qmultimap-unite] QMultiMap &unite(const QMultiMap &other); inline QMultiMap &operator+=(const QMultiMap &other) { return unite(other); } @@ -1222,6 +1224,7 @@ Q_INLINE_TEMPLATE typename QMap<Key, T>::iterator QMultiMap<Key, T>::insert(cons return typename QMap<Key, T>::iterator(z); } +#ifndef Q_CLANG_QDOC template <class Key, class T> typename QMap<Key, T>::iterator QMultiMap<Key, T>::insert(typename QMap<Key, T>::const_iterator pos, const Key &akey, const T &avalue) @@ -1287,6 +1290,7 @@ Q_INLINE_TEMPLATE QMultiMap<Key, T> &QMultiMap<Key, T>::unite(const QMultiMap<Ke } return *this; } +#endif // Q_CLANG_QDOC template <class Key, class T> Q_INLINE_TEMPLATE bool QMultiMap<Key, T>::contains(const Key &key, const T &value) const |