diff options
| author | Kai Köhne <kai.koehne@qt.io> | 2023-12-28 14:02:09 +0100 |
|---|---|---|
| committer | Alexey Edelev <alexey.edelev@qt.io> | 2024-01-16 10:29:24 +0100 |
| commit | 2e1d6ca2b139d6b31ead952ff3f4253f40e2fd75 (patch) | |
| tree | 761ac99df1730f75429895690217565d6a4bf9b9 | |
| parent | a68aefa8b338a08aefb7840c8fcd648c149563b2 (diff) | |
Doc: Improve class summaries
Linkify keywords. Properly capitalize CMake and JSON.
Use canonical qt_add_protobuf instead of the versioned
qt6_add_protobuf.
Change-Id: Ibda8ec3afd141c6903fe36610fdc6288067e6d30
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
(cherry picked from commit b335c4f1f43a5e031534310fe04aa51598205a1f)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
(cherry picked from commit 3152434c93786aca0f5fa7762fc0a0478c28b7f9)
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
| -rw-r--r-- | src/protobuf/qabstractprotobufserializer.cpp | 6 | ||||
| -rw-r--r-- | src/protobuf/qprotobufobject.qdoc | 2 | ||||
| -rw-r--r-- | src/protobuf/qprotobufserializer.cpp | 6 |
3 files changed, 7 insertions, 7 deletions
diff --git a/src/protobuf/qabstractprotobufserializer.cpp b/src/protobuf/qabstractprotobufserializer.cpp index 959aa85..55ea275 100644 --- a/src/protobuf/qabstractprotobufserializer.cpp +++ b/src/protobuf/qabstractprotobufserializer.cpp @@ -17,9 +17,9 @@ QT_BEGIN_NAMESPACE \reentrant The QProtobufSerializer class registers serializers/deserializers for - classes implementing a protobuf message, inheriting QProtobufMessage. These - classes are generated automatically, based on a .proto file, using the cmake - build macro qt6_add_protobuf or by running qtprotobufgen directly. + classes implementing a protobuf message, inheriting \l QProtobufMessage. These + classes are generated automatically, based on a \c{.proto} file, using the CMake + function \l qt_add_protobuf or by running \l qtprotobufgen directly. This class should be used as a base for specific serializers. The handlers property contains all message-specific serializers and should be used while diff --git a/src/protobuf/qprotobufobject.qdoc b/src/protobuf/qprotobufobject.qdoc index 1b50a0e..7d09257 100644 --- a/src/protobuf/qprotobufobject.qdoc +++ b/src/protobuf/qprotobufobject.qdoc @@ -16,6 +16,6 @@ \relates QAbstractProtobufSerializer \macro Q_PROTOBUF_OBJECT - Declares the propertyOrdering member in a class inheriting QProtobufMessage. + Declares the propertyOrdering member in a class inheriting \l QProtobufMessage. This is used as part of the code generated by the qtprotobufgen tool. */ diff --git a/src/protobuf/qprotobufserializer.cpp b/src/protobuf/qprotobufserializer.cpp index 5df7f48..6f81c45 100644 --- a/src/protobuf/qprotobufserializer.cpp +++ b/src/protobuf/qprotobufserializer.cpp @@ -80,9 +80,9 @@ QtProtobufPrivate::SerializationHandler QtProtobufPrivate::findHandler(QMetaType basic functions for serialization/deserialization. The QProtobufSerializer class registers serializers/deserializers for - classes implementing a protobuf message, inheriting QProtobufMessage. These - classes are generated automatically, based on a .proto file, using the cmake - build macro qt6_add_protobuf or by running qtprotobufgen directly. + classes implementing a protobuf message, inheriting \l QProtobufMessage. These + classes are generated automatically, based on a \c{.proto} file, using the CMake + function \l qt_add_protobuf or by running \l qtprotobufgen directly. */ /*! |