Update the documentation for the deserializationError(String)

Move the docs to the actual function implementations and adjust
the text to the one is used in the QAbstractProtobufSerializer.

Pick-to: 6.8 6.7
Change-Id: Ie7aa366e4b9a77c6c45d5a96fe627f50cb3f9df6
Reviewed-by: Dennis Oberst <dennis.oberst@qt.io>
This commit is contained in:
Alexey Edelev 2024-07-19 10:38:42 +02:00
parent 51f572f54c
commit 8cc1e7b09d
2 changed files with 16 additions and 27 deletions

View File

@ -36,20 +36,6 @@ QT_BEGIN_NAMESPACE
\l {The qtprotobufgen Tool} {qtprotobufgen} directly.
*/
/*!
\fn QAbstractProtobufSerializer::DeserializationError QProtobufJsonSerializer::deserializationError() const
Returns the last deserialization error.
*/
/*!
\fn QString QProtobufJsonSerializer::deserializationErrorString() const
Returns a human-readable string describing the last deserialization error.
If there was no error, an empty string is returned.
*/
using namespace Qt::StringLiterals;
using namespace QtProtobufPrivate;
@ -757,12 +743,20 @@ QProtobufJsonSerializer::QProtobufJsonSerializer() :
QProtobufJsonSerializer::~QProtobufJsonSerializer() = default;
/*!
Returns the last deserialization error for the serializer instance.
\sa deserializationErrorString()
*/
QAbstractProtobufSerializer::DeserializationError
QProtobufJsonSerializer::deserializationError() const
{
return d_ptr->deserializationError;
}
/*!
Returns the last deserialization error string for the serializer instance.
\sa deserializationError()
*/
QString QProtobufJsonSerializer::deserializationErrorString() const
{
return d_ptr->deserializationErrorString;

View File

@ -35,19 +35,6 @@ QT_BEGIN_NAMESPACE
\l {The qtprotobufgen Tool} {qtprotobufgen} directly.
*/
/*!
\fn QProtobufSerializer::DeserializationError QProtobufSerializer::deserializationError() const
Returns the last deserialization error.
*/
/*!
\fn QString QProtobufSerializer::deserializationErrorString() const
Returns a human-readable string describing the last deserialization error.
If there was no error, an empty string is returned.
*/
using namespace Qt::StringLiterals;
using namespace QtProtobufPrivate;
@ -673,11 +660,19 @@ bool QProtobufSerializerPrivate::storeCachedValue(QProtobufMessage *message)
return ok;
}
/*!
Returns the last deserialization error for the serializer instance.
\sa deserializationErrorString()
*/
QAbstractProtobufSerializer::DeserializationError QProtobufSerializer::deserializationError() const
{
return d_ptr->deserializationError;
}
/*!
Returns the last deserialization error string for the serializer instance.
\sa deserializationError()
*/
QString QProtobufSerializer::deserializationErrorString() const
{
return d_ptr->deserializationErrorString;