From 37213acd75729a0945145864135709bddde88a85 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Wed, 10 Nov 2021 13:11:47 +0100 Subject: [PATCH] Doc: Enable zero warning limit for documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pick-to: 6.3 Fixes: QTBUG-98116 Change-Id: I3d0a2ede380fd60bbe9c4e2852c4da3b737180ec Reviewed-by: Topi Reiniö --- coin/module_config.yaml | 1 + src/core/doc/qtqmlcore.qdocconf | 3 +++ src/labs/platform/doc/qtlabsplatform.qdocconf | 3 +++ src/qml/doc/qtqml.qdocconf | 3 +++ src/qmlmodels/doc/qtqmlmodels.qdocconf | 3 +++ src/qmltest/doc/qtqmltest.qdocconf | 3 +++ src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf | 3 +++ src/qmlxmllistmodel/doc/qtqmlxmllistmodel.qdocconf | 3 +++ src/quick/doc/qtquick.qdocconf | 3 +++ src/quickcontrols2/doc/qtquickcontrols.qdocconf | 3 +++ src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf | 3 +++ 11 files changed, 31 insertions(+) diff --git a/coin/module_config.yaml b/coin/module_config.yaml index 16d158c6b2..aaf3323822 100644 --- a/coin/module_config.yaml +++ b/coin/module_config.yaml @@ -10,3 +10,4 @@ instructions: Test: - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml" + - !include "{{qt/qtbase}}/coin_module_test_docs.yaml" diff --git a/src/core/doc/qtqmlcore.qdocconf b/src/core/doc/qtqmlcore.qdocconf index 49b92fcc17..96155f6594 100644 --- a/src/core/doc/qtqmlcore.qdocconf +++ b/src/core/doc/qtqmlcore.qdocconf @@ -32,3 +32,6 @@ navigation.landingpage = "Qt QML Core" navigation.qmltypespage = "Qt QML Core QML Types" tagfile = qtqmlcore.tags + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/src/labs/platform/doc/qtlabsplatform.qdocconf b/src/labs/platform/doc/qtlabsplatform.qdocconf index e83daff2e1..f159fff9bf 100644 --- a/src/labs/platform/doc/qtlabsplatform.qdocconf +++ b/src/labs/platform/doc/qtlabsplatform.qdocconf @@ -34,3 +34,6 @@ navigation.qmltypespage = "Qt Labs Platform QML Types" tagfile = qtlabsplatform.tags macro.labs = "\\note \\e{Types in Qt.labs modules are not guaranteed to remain compatible in future versions.}" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/src/qml/doc/qtqml.qdocconf b/src/qml/doc/qtqml.qdocconf index 1172478b78..2a7bcc7f9e 100644 --- a/src/qml/doc/qtqml.qdocconf +++ b/src/qml/doc/qtqml.qdocconf @@ -65,3 +65,6 @@ navigation.qmltypespage = "Qt QML QML Types" # suppress qdoc warnings for \instantiates entries spurious += "C\\+\\+ class .*\\\\instantiates .*" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/src/qmlmodels/doc/qtqmlmodels.qdocconf b/src/qmlmodels/doc/qtqmlmodels.qdocconf index 442e3ccc30..35910b7c71 100644 --- a/src/qmlmodels/doc/qtqmlmodels.qdocconf +++ b/src/qmlmodels/doc/qtqmlmodels.qdocconf @@ -34,3 +34,6 @@ navigation.qmltypespage = "Qt Qml Models QML Types" # suppress qdoc warnings for \instantiates entries spurious += "C\\+\\+ class .*\\\\instantiates .*" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/src/qmltest/doc/qtqmltest.qdocconf b/src/qmltest/doc/qtqmltest.qdocconf index 16ff9eeed3..2dbe68011e 100644 --- a/src/qmltest/doc/qtqmltest.qdocconf +++ b/src/qmltest/doc/qtqmltest.qdocconf @@ -36,3 +36,6 @@ exampledirs += snippets navigation.landingpage = "Qt Quick Test" navigation.cppclassespage = "Qt Quick Test C++ API" navigation.qmltypespage = "Qt Quick Test QML Types" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf b/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf index 33e2c2882a..ae8fd2b439 100644 --- a/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf +++ b/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf @@ -28,3 +28,6 @@ sourcedirs += .. exampledirs += snippets navigation.qmltypespage = "Qt Qml WorkerScript QML Types" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/src/qmlxmllistmodel/doc/qtqmlxmllistmodel.qdocconf b/src/qmlxmllistmodel/doc/qtqmlxmllistmodel.qdocconf index 41a79345b9..f23336d133 100644 --- a/src/qmlxmllistmodel/doc/qtqmlxmllistmodel.qdocconf +++ b/src/qmlxmllistmodel/doc/qtqmlxmllistmodel.qdocconf @@ -30,3 +30,6 @@ exampledirs += .. \ imagedirs += images navigation.qmltypespage = "Qt XmlListModel QML Types" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 diff --git a/src/quick/doc/qtquick.qdocconf b/src/quick/doc/qtquick.qdocconf index a6ec94b3fe..513ee0d04c 100644 --- a/src/quick/doc/qtquick.qdocconf +++ b/src/quick/doc/qtquick.qdocconf @@ -102,3 +102,6 @@ macro.svgcolor.HTML = "