diff options
| author | Dominik Holland <dominik.holland@qt.io> | 2022-09-07 16:58:45 +0200 |
|---|---|---|
| committer | Dominik Holland <dominik.holland@qt.io> | 2022-09-08 13:08:38 +0200 |
| commit | d6ca01ad8eb70c7c018ee87b019de6a380b73255 (patch) | |
| tree | ec0fdc13e56908859310641f484da1fbbc4757ce | |
| parent | 275c822f8e9106e05567116ccdf6dbbe0d69adcd (diff) | |
Doc: Fix broken snippets and other things
Also enforce zero warnings.
Change-Id: I15a9d32022deb339aefe805267eed9b28a8e14e9
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit 49b5372827aba4876ba9781d3c24b39532af7f41)
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
5 files changed, 9 insertions, 10 deletions
diff --git a/coin/module_config.yaml b/coin/module_config.yaml index 3fcd0a58..03172473 100644 --- a/coin/module_config.yaml +++ b/coin/module_config.yaml @@ -44,3 +44,4 @@ instructions: Test: - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml" + - !include "{{qt/qtbase}}/coin_module_test_docs.yaml" diff --git a/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc b/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc index 8813b98e..d949f6b5 100644 --- a/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc +++ b/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc @@ -238,7 +238,7 @@ open the \c instrumentcluster.h from the build folder and notice that the generated \c speed property changed -- it no longer has a setter anymore and is now read-only. - \quotefromfile interfaceframework/qface-tutorial/chapter2-enums-structs/frontend/instrumentcluster.h + \quotefromfile interfaceframework/qface-tutorial/chapter2-enums-structs/frontend/frontend/instrumentcluster.h \skipto class Q_EXAMPLE \printuntil Q_PROPERTY \dots @@ -275,7 +275,7 @@ In the auto-generated code, this results in an enum which is part of the module class, making it possible for the same enum to be used by multiple classes which are part of the same module: - \quotefile interfaceframework/qface-tutorial/chapter2-enums-structs/frontend/instrumentclustermodule.h + \quotefile interfaceframework/qface-tutorial/chapter2-enums-structs/frontend/frontend/instrumentclustermodule.h \section2 Add a New Structure diff --git a/src/ifmedia/doc/qtifmedia.qdocconf b/src/ifmedia/doc/qtifmedia.qdocconf index 904524e0..e545cbf3 100644 --- a/src/ifmedia/doc/qtifmedia.qdocconf +++ b/src/ifmedia/doc/qtifmedia.qdocconf @@ -1,8 +1,6 @@ headerdirs += .. \ - ../../imports/media sourcedirs += .. \ - ../../imports/media exampledirs += snippets diff --git a/src/ifvehiclefunctions/doc/qtifvehiclefunctions.qdocconf b/src/ifvehiclefunctions/doc/qtifvehiclefunctions.qdocconf index d0351ecf..33bc720b 100644 --- a/src/ifvehiclefunctions/doc/qtifvehiclefunctions.qdocconf +++ b/src/ifvehiclefunctions/doc/qtifvehiclefunctions.qdocconf @@ -1,9 +1,7 @@ headerdirs += .. \ - ../../imports/vehiclefunctions \ $$BUILDDIR/../ifvehiclefunctions \ sourcedirs += .. \ - ../../imports/vehiclefunctions \ $$BUILDDIR/../ifvehiclefunctions \ exampledirs += snippets diff --git a/src/interfaceframework/doc/qtinterfaceframework-project.qdocconf b/src/interfaceframework/doc/qtinterfaceframework-project.qdocconf index 7f856cd8..e7a38c94 100644 --- a/src/interfaceframework/doc/qtinterfaceframework-project.qdocconf +++ b/src/interfaceframework/doc/qtinterfaceframework-project.qdocconf @@ -9,15 +9,14 @@ includepaths = -I . \ headerdirs += . \ .. \ - ../../imports/core sourcedirs += . \ .. \ - $$BUILDDIR/../../examples \ - ../../imports/core + imagedirs += images exampledirs += ../../../examples \ - snippets/ + snippets/ \ + $$BUILDDIR/../../examples \ examples.fileextensions += *.qface *.yaml @@ -76,3 +75,6 @@ macro.fileLink = "\\l {https://code.qt.io/cgit/qt/interfaceframework.git/tree/\1 manifestmeta.filters = interfaceframework manifestmeta.interfaceframework.names = * manifestmeta.interfaceframework.tags = interfaceframework qtinterfaceframework qtif qif + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 |