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/serialization/qcborcommon.cpp | |
| 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/serialization/qcborcommon.cpp')
| -rw-r--r-- | src/corelib/serialization/qcborcommon.cpp | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/corelib/serialization/qcborcommon.cpp b/src/corelib/serialization/qcborcommon.cpp index 37fb198744..5fc47fa399 100644 --- a/src/corelib/serialization/qcborcommon.cpp +++ b/src/corelib/serialization/qcborcommon.cpp @@ -54,6 +54,8 @@ QT_BEGIN_NAMESPACE \brief The <QtCborCommon> header contains definitions common to both the streaming classes (QCborStreamReader and QCborStreamWriter) and to QCborValue. + + \sa QCborError */ /*! @@ -203,7 +205,7 @@ QDataStream &operator>>(QDataStream &ds, QCborSimpleType &st) /*! \class QCborError \inmodule QtCore - \relates <QtCborCommon> + \inheaderfile <QtCborCommon> \reentrant \since 5.12 |