mirror of https://github.com/qt/qtgrpc.git
Doc: Fix documentation issues
Qt gRPC:
* Add dependencies to qtdoc, qtcmake to get working navigation links.
* Add C++ module page.
* Move \since command to the \module page to have since information
for classes.
* Add a \qtcmakepackage for the \module.
* Comment out navigation information for QML types as those don't
exist.
Qt Protobuf:
* Create a preliminary landing page and move information from the
module page to it.
* Add dependencies to qtdoc, qtcmake docs.
* Add \since, \brief information for the module page.
* Fix issues in internal class documentation.
* Comment out navigation information for QML types.
Set both modules to 'Technical Preview' state.
Pick-to: 6.5
Task-number: QTBUG-109503
Change-Id: Iab99ad3df373373d6f15c4d71d42df71d2d5ab62
Reviewed-by: Konrad Kujawa <konrad.kujawa@qt.io>
Reviewed-by: Ievgenii Meshcheriakov <ievgenii.meshcheriakov@qt.io>
This commit is contained in:
parent
92ad7b1579
commit
26c9b1ca83
|
|
@ -2,9 +2,8 @@
|
||||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
/*!
|
/*!
|
||||||
\page qtgrpc-index.html
|
\page qtgrpc-index.html
|
||||||
\since 6.5
|
|
||||||
\title Qt gRPC
|
\title Qt gRPC
|
||||||
\brief Provides a gRPC
|
\brief Provides a gRPC.
|
||||||
|
|
||||||
\section1 Licenses
|
\section1 Licenses
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -27,19 +27,17 @@ qhp.QtGrpc.subprojects.classes.indexTitle = Qt gRPC C++ Classes
|
||||||
qhp.QtGrpc.subprojects.classes.selectors = class doc:headerfile
|
qhp.QtGrpc.subprojects.classes.selectors = class doc:headerfile
|
||||||
qhp.QtGrpc.subprojects.classes.sortPages = true
|
qhp.QtGrpc.subprojects.classes.sortPages = true
|
||||||
|
|
||||||
depends += qtcore qtnetwork
|
depends += qtdoc qtcore qtnetwork qtcmake
|
||||||
|
|
||||||
headerdirs += ..
|
{headerdirs,sourcedirs} += ..
|
||||||
|
|
||||||
sourcedirs += ..
|
|
||||||
|
|
||||||
exampledirs += ../../../examples/grpc
|
exampledirs += ../../../examples/grpc
|
||||||
|
|
||||||
imagedirs += images
|
imagedirs += images
|
||||||
|
|
||||||
navigation.landingpage = "Qt gRPC"
|
navigation.landingpage = "Qt gRPC"
|
||||||
navigation.qmltypespage = "Qt gRPC QML Types"
|
|
||||||
navigation.cppclassespage = "Qt gRPC C++ Classes"
|
navigation.cppclassespage = "Qt gRPC C++ Classes"
|
||||||
|
#navigation.qmltypespage = "Qt gRPC QML Types"
|
||||||
|
|
||||||
tagfile = qtgrpc.tags
|
tagfile = qtgrpc.tags
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
// Copyright (C) 2022 The Qt Company Ltd.
|
||||||
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
/*!
|
||||||
|
\module QtGrpc
|
||||||
|
\modulestate Technical Preview
|
||||||
|
\title Qt gRPC C++ Classes
|
||||||
|
\qtcmakepackage Grpc
|
||||||
|
\since 6.5
|
||||||
|
|
||||||
|
\brief Provides gRPC support for Qt.
|
||||||
|
*/
|
||||||
|
|
@ -27,21 +27,18 @@ qhp.QtProtobuf.subprojects.classes.indexTitle = Qt Protobuf C++ Classes
|
||||||
qhp.QtProtobuf.subprojects.classes.selectors = class doc:headerfile
|
qhp.QtProtobuf.subprojects.classes.selectors = class doc:headerfile
|
||||||
qhp.QtProtobuf.subprojects.classes.sortPages = true
|
qhp.QtProtobuf.subprojects.classes.sortPages = true
|
||||||
|
|
||||||
depends += qtcore
|
depends += qtdoc qtcore qtcmake
|
||||||
|
|
||||||
headerdirs += ..
|
{headerdirs,sourcedirs} += ..
|
||||||
|
sourcedirs += ../../tools/qtprotobufgen/doc/src
|
||||||
sourcedirs += src \
|
|
||||||
.. \
|
|
||||||
../../tools/qtprotobufgen/doc/src
|
|
||||||
|
|
||||||
exampledirs += ../../../examples/protobuf
|
exampledirs += ../../../examples/protobuf
|
||||||
|
|
||||||
imagedirs += images
|
imagedirs += images
|
||||||
|
|
||||||
navigation.landingpage = "Qt Protobuf"
|
navigation.landingpage = "Qt Protobuf"
|
||||||
navigation.qmltypespage = "Qt Protobuf QML Types"
|
|
||||||
navigation.cppclassespage = "Qt Protobuf C++ Classes"
|
navigation.cppclassespage = "Qt Protobuf C++ Classes"
|
||||||
|
#navigation.qmltypespage = "Qt Protobuf QML Types"
|
||||||
|
|
||||||
tagfile = qtprotobuf.tags
|
tagfile = qtprotobuf.tags
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,13 +2,10 @@
|
||||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\module QtProtobuf
|
|
||||||
\title Protocol Buffers Support in Qt
|
|
||||||
\brief An overview of Protobuf support in Qt.
|
|
||||||
|
|
||||||
\ingroup frameworks-technologies
|
|
||||||
|
|
||||||
\keyword Protobuf
|
\keyword Protobuf
|
||||||
|
\page qtprotobuf-index.html
|
||||||
|
\title Qt Protobuf
|
||||||
|
\ingroup frameworks-technologies
|
||||||
|
|
||||||
Qt provides a generator which can be used to generate Qt-based classes
|
Qt provides a generator which can be used to generate Qt-based classes
|
||||||
from \c{.proto} files. These generated classes can then be used to serialize
|
from \c{.proto} files. These generated classes can then be used to serialize
|
||||||
|
|
@ -18,4 +15,19 @@
|
||||||
\list
|
\list
|
||||||
\li \l{CMake Commands in Qt6 Protobuf}
|
\li \l{CMake Commands in Qt6 Protobuf}
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
|
\section1 Reference Documentation
|
||||||
|
|
||||||
|
\list
|
||||||
|
\l {Qt Protobuf C++ Classes}{C++ Classes}
|
||||||
|
\endlist
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\module QtProtobuf
|
||||||
|
\modulestate Technical Preview
|
||||||
|
\title Qt Protobuf C++ Classes
|
||||||
|
\qtcmakepackage Protobuf
|
||||||
|
\since 6.5
|
||||||
|
\brief Provides protocol buffers support in Qt.
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -305,7 +305,6 @@ QT_IMPL_METATYPE_EXTERN_TAGGED(QtProtobuf::sfixed32, QtProtobuf_sfixed32)
|
||||||
QT_IMPL_METATYPE_EXTERN_TAGGED(QtProtobuf::sfixed64, QtProtobuf_sfixed64)
|
QT_IMPL_METATYPE_EXTERN_TAGGED(QtProtobuf::sfixed64, QtProtobuf_sfixed64)
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\inmodule QtProtobuf
|
|
||||||
\enum QtProtobuf::WireTypes
|
\enum QtProtobuf::WireTypes
|
||||||
\brief The WireTypes enumeration reflects protobuf default wiretypes.
|
\brief The WireTypes enumeration reflects protobuf default wiretypes.
|
||||||
|
|
||||||
|
|
@ -324,8 +323,8 @@ QT_IMPL_METATYPE_EXTERN_TAGGED(QtProtobuf::sfixed64, QtProtobuf_sfixed64)
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\inmodule QtProtobuf
|
|
||||||
\class QProtobufPropertyOrderingInfo
|
\class QProtobufPropertyOrderingInfo
|
||||||
|
\inmodule QtProtobuf
|
||||||
\internal
|
\internal
|
||||||
\brief Holds a property's index in the property system, and the json_name.
|
\brief Holds a property's index in the property system, and the json_name.
|
||||||
|
|
||||||
|
|
@ -352,8 +351,10 @@ QT_IMPL_METATYPE_EXTERN_TAGGED(QtProtobuf::sfixed64, QtProtobuf_sfixed64)
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\class template<typename T, int = 0> struct QtProtobuf::transparent
|
\struct QtProtobuf::transparent
|
||||||
\internal Only used to create new, unique types for numeric types.
|
\inmodule QtProtobuf
|
||||||
|
\internal
|
||||||
|
\brief Only used to create new, unique types for numeric types.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue