qiurui
/
qtgrpc
mirror of https://github.com/qt/qtgrpc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: Use \relates for functions in the global scope 

This addresses the recent warnings introduced by a change to QDoc:

qtprotobuftypes.h:234: (qdoc) warning: No documentation generated for
    function 'qRegisterProtobufTypes' in global scope.
qprotobufserializer.h:319: (qdoc) warning: No documentation generated
    for function 'qRegisterProtobufType' in global scope.
qprotobufserializer.h:333: (qdoc) warning: No documentation generated
    for function 'qRegisterProtobufMapType' in global scope.
qprotobufserializer.h:361: (qdoc) warning: No documentation generated
    for function 'qRegisterProtobufEnumType' in global scope.

Pick-to: 6.5
Change-Id: I694b4a524a31c477bb3e4b52ea89b0c4823c0430
Reviewed-by: Konrad Kujawa <konrad.kujawa@qt.io>
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
This commit is contained in:
Topi Reinio 2023-03-28 06:54:28 +00:00
parent 096a630cdf
commit 5249e95b3a
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/protobuf/qprotobufserializer.cpp
View File

@ -163,6 +163,7 @@ QtProtobufPrivate::SerializationHandler QtProtobufPrivate::findHandler(QMetaType
*/
/*!
\relates QProtobufSerializer
\fn template<typename T> inline void qRegisterProtobufType()
Registers a Protobuf type \a T.
@ -170,6 +171,7 @@ QtProtobufPrivate::SerializationHandler QtProtobufPrivate::findHandler(QMetaType
*/
/*!
\relates QProtobufSerializer
\fn template<typename K, typename V> inline void qRegisterProtobufMapType();
Registers a Protobuf map type \c K and \c V.
@ -178,6 +180,7 @@ QtProtobufPrivate::SerializationHandler QtProtobufPrivate::findHandler(QMetaType
*/
/*!
\relates QProtobufSerializer
\fn template<typename T> inline void qRegisterProtobufEnumType();
Registers serializers for enumeration type \c T in QtProtobuf global

1
src/protobuf/qtprotobuftypes.cpp
View File

@ -277,6 +277,7 @@ static void qRegisterBaseTypes()
}
/*!
\relates QtProtobuf
Calling this function registers all, currently known, protobuf types with
the serializer registry.