diff options
| author | Sona Kurazyan <sona.kurazyan@qt.io> | 2021-10-08 18:06:49 +0200 |
|---|---|---|
| committer | Sona Kurazyan <sona.kurazyan@qt.io> | 2021-10-18 13:42:07 +0200 |
| commit | 8a8bf1b84e9a096993b892873eb62c735149f320 (patch) | |
| tree | 3993d9c3998d3471197b747eca7f50d1c45e1ea9 /src/corelib/io/qdebug.cpp | |
| parent | 2f2fdc418d88dbb2b7e8dbf574d51286354067a7 (diff) | |
Fix docs for comparison/debug/data stream operators of Qt containers
Because of the constraints on comparison, debug and data stream
operators, the return types for them look weird in docs. Conditionally
use the actual return types, in case if Q_CLANG_QDOC is defined.
Also add the docs of debug stream operators for types for which they
were misssing.
Task-number: QTBUG-97247
Pick-to: 6.2
Change-Id: I57f2c52bd3af805c7eeebb602c47de1e95ee09bd
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Diffstat (limited to 'src/corelib/io/qdebug.cpp')
| -rw-r--r-- | src/corelib/io/qdebug.cpp | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/corelib/io/qdebug.cpp b/src/corelib/io/qdebug.cpp index 1889a4c3a24..a7ce66ad148 100644 --- a/src/corelib/io/qdebug.cpp +++ b/src/corelib/io/qdebug.cpp @@ -856,6 +856,14 @@ QDebug &QDebug::resetFormat() */ /*! + \fn template <class Key, class T> QDebug operator<<(QDebug debug, const QMultiMap<Key, T> &map) + \relates QDebug + + Writes the contents of \a map to \a debug. Both \c Key and + \c T need to support streaming into QDebug. +*/ + +/*! \fn template <typename Key, typename T, typename Compare, typename Alloc> QDebug operator<<(QDebug debug, const std::map<Key, T, Compare, Alloc> &map) \relates QDebug \since 5.7 @@ -882,6 +890,14 @@ QDebug &QDebug::resetFormat() */ /*! + \fn template <class Key, class T> QDebug operator<<(QDebug debug, const QMultiHash<Key, T> &hash) + \relates QDebug + + Writes the contents of \a hash to \a debug. Both \c Key and + \c T need to support streaming into QDebug. +*/ + +/*! \fn template <class T1, class T2> QDebug operator<<(QDebug debug, const QPair<T1, T2> &pair) \relates QDebug @@ -890,6 +906,22 @@ QDebug &QDebug::resetFormat() */ /*! + \fn template <class T1, class T2> QDebug operator<<(QDebug debug, const std::pair<T1, T2> &pair) + \relates QDebug + + Writes the contents of \a pair to \a debug. Both \c T1 and + \c T2 need to support streaming into QDebug. +*/ + +/*! + \fn template <typename T> QDebug operator<<(QDebug debug, const QContiguousCache<T> &cache) + \relates QDebug + + Writes the contents of \a cache to \a debug. \c T needs to + support streaming into QDebug. +*/ + +/*! \fn template<typename T> QDebug operator<<(QDebug debug, const QFlags<T> &flags) \relates QDebug \since 4.7 |