From a9c47dde501d0e178a254920bd487dca956895be Mon Sep 17 00:00:00 2001 From: Edward Welbourne Date: Fri, 1 Sep 2023 16:40:26 +0200 Subject: [PATCH] Rename Convert Example to Serialization Converter The old name didn't say what sort of thing it was converting; and our guidelines for examples discourage using the word Example in the title. Also reword the description of the tool in the command-line parser and an assertion. Pick-to: 6.6 6.5 Task-number: QTBUG-111228 Change-Id: I6f52f5227362b4b807c8aabfd2103287af42bca0 Reviewed-by: Ivan Solovev --- examples/corelib/serialization/convert/doc/src/convert.qdoc | 2 +- examples/corelib/serialization/convert/main.cpp | 6 +++--- src/corelib/doc/src/cbor.qdoc | 2 +- src/corelib/serialization/qcborarray.cpp | 2 +- src/corelib/serialization/qcborcommon.cpp | 2 +- src/corelib/serialization/qcbormap.cpp | 2 +- src/corelib/serialization/qcborstreamreader.cpp | 2 +- src/corelib/serialization/qcborstreamwriter.cpp | 2 +- src/corelib/serialization/qcborvalue.cpp | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/examples/corelib/serialization/convert/doc/src/convert.qdoc b/examples/corelib/serialization/convert/doc/src/convert.qdoc index 0557aa1836..e51a619e31 100644 --- a/examples/corelib/serialization/convert/doc/src/convert.qdoc +++ b/examples/corelib/serialization/convert/doc/src/convert.qdoc @@ -5,7 +5,7 @@ \example serialization/convert \examplecategory {Data Processing & I/O} \meta tag {network} - \title Convert Example + \title Serialization Converter \brief The Convert example demonstrates how to convert between different serialization formats. diff --git a/examples/corelib/serialization/convert/main.cpp b/examples/corelib/serialization/convert/main.cpp index a916175332..cd70a909ba 100644 --- a/examples/corelib/serialization/convert/main.cpp +++ b/examples/corelib/serialization/convert/main.cpp @@ -91,7 +91,7 @@ int main(int argc, char *argv[]) outputFormats.prepend("auto"_L1); QCommandLineParser parser; - parser.setApplicationDescription("Qt file format conversion tool"_L1); + parser.setApplicationDescription("Qt serialization format conversion tool"_L1); parser.addHelpOption(); QCommandLineOption inputFormatOption(QStringList{ "I"_L1, "input-format"_L1 }); @@ -154,9 +154,9 @@ int main(int argc, char *argv[]) const Converter *outconv = prepareConverter(parser.value(outputFormatOption), Converter::Direction::Out, &output); - // now finally perform the conversion + // Now finally perform the conversion: QVariant data = inconv->loadFile(&input, outconv); - Q_ASSERT_X(outconv, "Converter Tool", + Q_ASSERT_X(outconv, "Serialization Converter", "Internal error: converter format did not provide default"); outconv->saveFile(&output, data, parser.values(optionOption)); return EXIT_SUCCESS; diff --git a/src/corelib/doc/src/cbor.qdoc b/src/corelib/doc/src/cbor.qdoc index 1357d2ac11..30d7ddaf60 100644 --- a/src/corelib/doc/src/cbor.qdoc +++ b/src/corelib/doc/src/cbor.qdoc @@ -36,7 +36,7 @@ In addition, CBOR can add a "tag" to extend the meaning of the type. The container types can contain basic types, string-like types and containers. - \sa {Parsing and displaying CBOR data}, {Convert Example}, {Saving and Loading a Game} + \sa {Parsing and displaying CBOR data}, {Serialization Converter}, {Saving and Loading a Game} \section1 The CBOR Classes diff --git a/src/corelib/serialization/qcborarray.cpp b/src/corelib/serialization/qcborarray.cpp index d79f503bb3..ccffc11ad9 100644 --- a/src/corelib/serialization/qcborarray.cpp +++ b/src/corelib/serialization/qcborarray.cpp @@ -32,7 +32,7 @@ using namespace QtCbor; conversions. \sa QCborValue, QCborMap, QJsonArray, QList, {Parsing and displaying CBOR data}, - {Convert Example}, {Saving and Loading a Game} + {Serialization Converter}, {Saving and Loading a Game} */ /*! diff --git a/src/corelib/serialization/qcborcommon.cpp b/src/corelib/serialization/qcborcommon.cpp index 42955b009f..b3d4f70aa2 100644 --- a/src/corelib/serialization/qcborcommon.cpp +++ b/src/corelib/serialization/qcborcommon.cpp @@ -180,7 +180,7 @@ QDataStream &operator>>(QDataStream &ds, QCborSimpleType &st) validating a CBOR stream. \sa QCborStreamReader, QCborValue, QCborParserError, - {Parsing and displaying CBOR data}, {Convert Example}, + {Parsing and displaying CBOR data}, {Serialization Converter}, {Saving and Loading a Game} */ diff --git a/src/corelib/serialization/qcbormap.cpp b/src/corelib/serialization/qcbormap.cpp index ab4e78ebb9..57186a3d1f 100644 --- a/src/corelib/serialization/qcbormap.cpp +++ b/src/corelib/serialization/qcbormap.cpp @@ -48,7 +48,7 @@ using namespace QtCbor; will not undo. \sa QCborArray, QCborValue, QJsonDocument, QVariantMap, - {Parsing and displaying CBOR data}, {Convert Example}, + {Parsing and displaying CBOR data}, {Serialization Converter}, {Saving and Loading a Game} */ diff --git a/src/corelib/serialization/qcborstreamreader.cpp b/src/corelib/serialization/qcborstreamreader.cpp index 903ef690a0..4eb936af41 100644 --- a/src/corelib/serialization/qcborstreamreader.cpp +++ b/src/corelib/serialization/qcborstreamreader.cpp @@ -151,7 +151,7 @@ static_assert(int(QCborStreamReader::Invalid) == CborInvalidType); a the QIDOevice that now has more data available (see setDevice()). \sa QCborStreamWriter, QCborValue, QXmlStreamReader, - {Parsing and displaying CBOR data}, {Convert Example}, + {Parsing and displaying CBOR data}, {Serialization Converter}, {Saving and Loading a Game} */ diff --git a/src/corelib/serialization/qcborstreamwriter.cpp b/src/corelib/serialization/qcborstreamwriter.cpp index 795b7875de..be7a918607 100644 --- a/src/corelib/serialization/qcborstreamwriter.cpp +++ b/src/corelib/serialization/qcborstreamwriter.cpp @@ -176,7 +176,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); \endlist \sa QCborStreamReader, QCborValue, QXmlStreamWriter - {Parsing and displaying CBOR data}, {Convert Example}, + {Parsing and displaying CBOR data}, {Serialization Converter}, {Saving and Loading a Game} */ diff --git a/src/corelib/serialization/qcborvalue.cpp b/src/corelib/serialization/qcborvalue.cpp index 1d58f6487d..f8758720a8 100644 --- a/src/corelib/serialization/qcborvalue.cpp +++ b/src/corelib/serialization/qcborvalue.cpp @@ -192,7 +192,7 @@ Q_DECL_UNUSED static constexpr quint64 MaximumPreallocatedElementCount = aspects, its API is identical to QCborValue. \sa QCborArray, QCborMap, QCborStreamReader, QCborStreamWriter, - QJsonValue, QJsonDocument, {Convert Example}, {Saving and Loading a Game} + QJsonValue, QJsonDocument, {Serialization Converter}, {Saving and Loading a Game} {Parsing and displaying CBOR data} */