diff --git a/src/grpc/doc/qtgrpc.qdocconf b/src/grpc/doc/qtgrpc.qdocconf index 9d3d9b17..25483a47 100644 --- a/src/grpc/doc/qtgrpc.qdocconf +++ b/src/grpc/doc/qtgrpc.qdocconf @@ -39,16 +39,15 @@ qhp.QtGrpc.subprojects.manual.type = manual depends += qtdoc qtcore qtnetwork qtwidgets qtprotobuf qtcmake qtqml {headerdirs,sourcedirs} += .. \ - ../../tools/doc/src \ - ../../tools/qtgrpcgen/doc/src \ ../../grpcquick +# Add additional documentation dirs +sourcedirs += ../../tools/doc -exampledirs += ../../tools/qtgrpcgen/doc/src/snippets \ - ../../../examples/grpc +exampledirs += src/snippets \ + ../../../examples/grpc -imagedirs += images \ - ../../../examples/grpc/doc/images +imagedirs += ../../../examples/grpc/doc/images navigation.landingpage = "Qt GRPC" navigation.cppclassespage = "Qt GRPC C++ Classes" diff --git a/src/tools/qtgrpcgen/doc/src/qt-add-grpc-example.qdocinc b/src/grpc/doc/src/qt-add-grpc-example.qdocinc similarity index 100% rename from src/tools/qtgrpcgen/doc/src/qt-add-grpc-example.qdocinc rename to src/grpc/doc/src/qt-add-grpc-example.qdocinc diff --git a/src/grpc/doc/src/qt_add_grpc.qdoc b/src/grpc/doc/src/qt-add-grpc.qdoc similarity index 93% rename from src/grpc/doc/src/qt_add_grpc.qdoc rename to src/grpc/doc/src/qt-add-grpc.qdoc index 8555f4d8..8ebccd2f 100644 --- a/src/grpc/doc/src/qt_add_grpc.qdoc +++ b/src/grpc/doc/src/qt-add-grpc.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_add_grpc.html +\page qt-add-grpc.html \ingroup cmake-commands-qtgrpc \title qt_add_grpc @@ -76,9 +76,9 @@ target to the protobuf one: \li \c TARGET_TYPE is the type of gRPC code to be generated. Although gRPC supports a client-server architecture, only CLIENT source code can be generated. - \include qtgrpcgen-options.qdocinc 0 - \include qtprotoccommon-options.qdocinc 0 - \include qtprotogen-cmake-options.qdocinc 0 + \include qtgrpcgen.qdocinc 0 + \include qtprotoccommon.qdocinc 0 + \include qtprotoccommon.qdocinc 1 \endlist \sa{The qtgrpcgen Tool} diff --git a/src/tools/qtgrpcgen/doc/src/qtgrpcgen.qdoc b/src/grpc/doc/src/qtgrpcgen.qdoc similarity index 96% rename from src/tools/qtgrpcgen/doc/src/qtgrpcgen.qdoc rename to src/grpc/doc/src/qtgrpcgen.qdoc index 4490fe8e..d5d9a52b 100644 --- a/src/tools/qtgrpcgen/doc/src/qtgrpcgen.qdoc +++ b/src/grpc/doc/src/qtgrpcgen.qdoc @@ -61,7 +61,7 @@ Options have direct aliases in the \l{qt_add_grpc} function. The following options are supported: \list - \include qtprotoccommon-options.qdocinc 0 - \include qtgrpcgen-options.qdocinc 0 + \include qtprotoccommon.qdocinc 0 + \include qtgrpcgen.qdocinc 0 \endlist */ diff --git a/src/tools/qtgrpcgen/doc/src/qtgrpcgen-options.qdocinc b/src/grpc/doc/src/qtgrpcgen.qdocinc similarity index 100% rename from src/tools/qtgrpcgen/doc/src/qtgrpcgen-options.qdocinc rename to src/grpc/doc/src/qtgrpcgen.qdocinc diff --git a/src/tools/qtgrpcgen/doc/src/snippets/qt-add-grpc-example.cmake b/src/grpc/doc/src/snippets/qt-add-grpc-example.cmake similarity index 100% rename from src/tools/qtgrpcgen/doc/src/snippets/qt-add-grpc-example.cmake rename to src/grpc/doc/src/snippets/qt-add-grpc-example.cmake diff --git a/src/grpcquick/doc/src/qtgrpcquick-qmltypes.qdoc b/src/grpcquick/doc/qtgrpcquick-qmltypes.qdoc similarity index 100% rename from src/grpcquick/doc/src/qtgrpcquick-qmltypes.qdoc rename to src/grpcquick/doc/qtgrpcquick-qmltypes.qdoc diff --git a/src/protobuf/doc/qtprotobuf.qdocconf b/src/protobuf/doc/qtprotobuf.qdocconf index 66c22715..585121ae 100644 --- a/src/protobuf/doc/qtprotobuf.qdocconf +++ b/src/protobuf/doc/qtprotobuf.qdocconf @@ -60,14 +60,14 @@ depends += qtdoc qtcore qtgui qtcmake qtgrpc qtwidgets qtqml qtquickcontrols {headerdirs,sourcedirs} += .. \ ../../protobufqttypes \ ../../wellknown -sourcedirs += ../../tools/doc/src \ - ../../tools/qtprotobufgen/doc/src -exampledirs += ../../../examples/protobuf \ - ../../tools/qtprotobufgen/doc/src/snippets +# Add additional documentation dirs +sourcedirs += ../../tools/doc + +exampledirs += ../../../examples/protobuf imagedirs += images \ - ../../../examples/protobuf/sensors/doc/images + ../../../examples/protobuf/sensors/doc/images navigation.landingpage = "Qt Protobuf" navigation.cppclassespage = "Qt Protobuf C++ Classes" diff --git a/src/tools/qtprotobufgen/doc/src/qt-add-protobuf-example.qdocinc b/src/protobuf/doc/src/qt-add-protobuf-example.qdocinc similarity index 100% rename from src/tools/qtprotobufgen/doc/src/qt-add-protobuf-example.qdocinc rename to src/protobuf/doc/src/qt-add-protobuf-example.qdocinc diff --git a/src/protobuf/doc/src/qt_add_protobuf.qdoc b/src/protobuf/doc/src/qt-add-protobuf.qdoc similarity index 97% rename from src/protobuf/doc/src/qt_add_protobuf.qdoc rename to src/protobuf/doc/src/qt-add-protobuf.qdoc index 9149b80c..00b4c23c 100644 --- a/src/protobuf/doc/src/qt_add_protobuf.qdoc +++ b/src/protobuf/doc/src/qt-add-protobuf.qdoc @@ -35,7 +35,7 @@ link to. \section1 Arguments \list - \include qtprotoccommon-options.qdocinc 0 + \include qtprotoccommon.qdocinc 0 \li \c QML enables QProtobufMessage types in QML context by registering them as a QML module. Protobuf types can extend an existing QML module: @@ -93,8 +93,8 @@ link to. \c QML_URI or proto package name, because it leads to import error in QML context. - \include qtprotogen-options.qdocinc 0 - \include qtprotogen-cmake-options.qdocinc 0 + \include qtprotobufgen.qdocinc 0 + \include qtprotoccommon.qdocinc 1 \endlist \sa{The qtprotobufgen Tool} diff --git a/src/tools/qtprotobufgen/doc/src/qtprotobufgen.qdoc b/src/protobuf/doc/src/qtprotobufgen.qdoc similarity index 96% rename from src/tools/qtprotobufgen/doc/src/qtprotobufgen.qdoc rename to src/protobuf/doc/src/qtprotobufgen.qdoc index bc6ef94a..a647d850 100644 --- a/src/tools/qtprotobufgen/doc/src/qtprotobufgen.qdoc +++ b/src/protobuf/doc/src/qtprotobufgen.qdoc @@ -64,7 +64,7 @@ Options have direct aliases in the \l{qt_add_protobuf} function. The following options are supported: \list - \include qtprotoccommon-options.qdocinc 0 - \include qtprotogen-options.qdocinc 0 + \include qtprotoccommon.qdocinc 0 + \include qtprotobufgen.qdocinc 0 \endlist */ diff --git a/src/tools/qtprotobufgen/doc/src/qtprotogen-options.qdocinc b/src/protobuf/doc/src/qtprotobufgen.qdocinc similarity index 100% rename from src/tools/qtprotobufgen/doc/src/qtprotogen-options.qdocinc rename to src/protobuf/doc/src/qtprotobufgen.qdocinc diff --git a/src/protobufqttypes/protobufqtcoretypes/doc/src/protobufqtcoretypes.qdoc b/src/protobufqttypes/doc/protobufqtcoretypes.qdoc similarity index 100% rename from src/protobufqttypes/protobufqtcoretypes/doc/src/protobufqtcoretypes.qdoc rename to src/protobufqttypes/doc/protobufqtcoretypes.qdoc diff --git a/src/protobufqttypes/protobufqtguitypes/doc/src/protobufqtguitypes.qdoc b/src/protobufqttypes/doc/protobufqtguitypes.qdoc similarity index 100% rename from src/protobufqttypes/protobufqtguitypes/doc/src/protobufqtguitypes.qdoc rename to src/protobufqttypes/doc/protobufqtguitypes.qdoc diff --git a/src/tools/doc/src/qtprotoccommon-options.qdocinc b/src/tools/doc/qtprotoccommon.qdocinc similarity index 61% rename from src/tools/doc/src/qtprotoccommon-options.qdocinc rename to src/tools/doc/qtprotoccommon.qdocinc index 088015e6..962b198f 100644 --- a/src/tools/doc/src/qtprotoccommon-options.qdocinc +++ b/src/tools/doc/qtprotoccommon.qdocinc @@ -18,3 +18,19 @@ the generation of the file containing the macro definitions. If \c macro_output_file is not set, the option falls back to the old syntax handling. //! [0] + +//! [1] +\li \c PROTO_FILES is the list of \c .proto files that will be used in the +generation procedure. +\li \c PROTO_INCLUDES is the list of directories that will be searched for +dependencies. +\li \c OUTPUT_DIRECTORY is the directory where the generated files will be +put. By default, the current directory (while evaluating the function) is +used. +\li \c OUTPUT_HEADERS can be used to specify a variable that will +hold the list of headers created by the function. This list can be useful for +custom project install rules. +\li \c OUTPUT_TARGETS can be used to specify a variable that will +hold the list of targets created by the function. This list can be useful for +custom project install rules. +//! [1] diff --git a/src/tools/doc/src/qtprotogen-cmake-options.qdocinc b/src/tools/doc/src/qtprotogen-cmake-options.qdocinc deleted file mode 100644 index 19564a79..00000000 --- a/src/tools/doc/src/qtprotogen-cmake-options.qdocinc +++ /dev/null @@ -1,18 +0,0 @@ -// Copyright (C) 2022 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only - -//! [0] -\li \c PROTO_FILES is the list of \c .proto files that will be used in the -generation procedure. -\li \c PROTO_INCLUDES is the list of directories that will be searched for -dependencies. -\li \c OUTPUT_DIRECTORY is the directory where the generated files will be -put. By default, the current directory (while evaluating the function) is -used. -\li \c OUTPUT_HEADERS can be used to specify a variable that will -hold the list of headers created by the function. This list can be useful for -custom project install rules. -\li \c OUTPUT_TARGETS can be used to specify a variable that will -hold the list of targets created by the function. This list can be useful for -custom project install rules. -//! [0] diff --git a/src/wellknown/doc/qtprotobufwellknowntypes-module.qdoc b/src/wellknown/doc/qtprotobufwellknowntypes.qdoc similarity index 100% rename from src/wellknown/doc/qtprotobufwellknowntypes-module.qdoc rename to src/wellknown/doc/qtprotobufwellknowntypes.qdoc