Docs: reorder extra documentation to be module bound

Slim down the many unneeded extra files / dirs we've had. It only adds
to the confusion having every tiny thing separated into a specific file
or extra subfolder.

All non-main modules (extras) now take simply doc/ without src/

Task-number: QTBUG-125406
Pick-to: 6.8
Change-Id: If3e5206a486726f43f8a38285b7dd0f1fff81a88
Reviewed-by:  Alexey Edelev <alexey.edelev@qt.io>
This commit is contained in:
Dennis Oberst 2024-09-02 21:53:14 +02:00
parent 52736b677e
commit 20eeace9ab
17 changed files with 37 additions and 40 deletions

View File

@ -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 \
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"

View File

@ -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}

View File

@ -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
*/

View File

@ -60,11 +60,11 @@ 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

View File

@ -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}

View File

@ -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
*/

View File

@ -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]

View File

@ -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]