diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-10-30 14:13:31 +0100 |
---|---|---|
committer | Jani Heikkinen <jani.heikkinen@qt.io> | 2018-11-06 12:44:21 +0000 |
commit | 46a595b047a928b1a5d527065c6814ef05e3a97b (patch) | |
tree | 15c30e340c416246e31ce89587c6f26f841fa575 | |
parent | a92735ec007b7cafacb70029ce10f039ace66515 (diff) |
Doc: QCbor classes: Fix \variable commands
\variable must not include the variable type, QDoc will resolve that.
This commit resolves four documentation warnings.
Task-number: QTBUG-71502
Change-Id: I5e88cf66d3c3bb8f18495d5477e1271ac2cd9e74
Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r-- | src/corelib/serialization/qcborstream.cpp | 6 | ||||
-rw-r--r-- | src/corelib/serialization/qcborvalue.cpp | 4 |
2 files changed, 6 insertions, 4 deletions
diff --git a/src/corelib/serialization/qcborstream.cpp b/src/corelib/serialization/qcborstream.cpp index 22286188b8..7628019943 100644 --- a/src/corelib/serialization/qcborstream.cpp +++ b/src/corelib/serialization/qcborstream.cpp @@ -1422,12 +1422,14 @@ bool QCborStreamWriter::endMap() */ /*! - \variable Container QCborStreamReader::StringResult::data + \variable QCborStreamReader::StringResult::data + Contains the actual data from the string if \l status is \c Ok. */ /*! - \variable QCborStreamReader::StringResultCode QCborStreamReader::StringResult::status + \variable QCborStreamReader::StringResult::status + Contains the status of the attempt of reading the string from the stream. */ diff --git a/src/corelib/serialization/qcborvalue.cpp b/src/corelib/serialization/qcborvalue.cpp index 5d97a6a06a..e53b6a0326 100644 --- a/src/corelib/serialization/qcborvalue.cpp +++ b/src/corelib/serialization/qcborvalue.cpp @@ -221,7 +221,7 @@ QT_BEGIN_NAMESPACE */ /*! - \variable qint64 QCborParserError::offset + \variable QCborParserError::offset This field contains the offset from the beginning of the data where the error was detected. The offset should point to the beginning of the item @@ -232,7 +232,7 @@ QT_BEGIN_NAMESPACE */ /*! - \variable QCborError QCborParserError::error + \variable QCborParserError::error This field contains the error code that indicates what decoding problem was found. |