Doc: Enable zero warning limit for documentation

Pick-to: 6.3 Fixes: QTBUG-98116 Change-Id: I3d0a2ede380fd60bbe9c4e2852c4da3b737180ec Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-11-10 13:11:47 +01:00 · 2021-11-10 13:11:47 +01:00 · 37213acd75
parent fddd82345a
commit 37213acd75
11 changed files with 31 additions and 0 deletions
--- 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"
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- a/src/quick/doc/qtquick.qdocconf
+++ b/src/quick/doc/qtquick.qdocconf
@ -102,3 +102,6 @@ macro.svgcolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\"></d

 # suppress qdoc warnings for \instantiates entries
 spurious += "C\\+\\+ class .*\\\\instantiates .*"
+
+# Fail the documentation build if there are more warnings than the limit
+warninglimit = 0
--- a/src/quickcontrols2/doc/qtquickcontrols.qdocconf
+++ b/src/quickcontrols2/doc/qtquickcontrols.qdocconf
@ -99,3 +99,6 @@ macro.nbsp.HTML = "&nbsp;"
 #Add output suffix to the html filenames
 outputsuffixes = QML
 outputsuffixes.QML = 2
+
+# Fail the documentation build if there are more warnings than the limit
+warninglimit = 0
--- a/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf
+++ b/src/quickdialogs2/quickdialogs2/doc/qtquickdialogs.qdocconf
@ -34,3 +34,6 @@ navigation.landingpage  = "Qt Quick Dialogs"
 navigation.qmltypespage = "Qt Quick Dialogs QML Types"

 tagfile                 = qtquickdialogs.tags
+
+# Fail the documentation build if there are more warnings than the limit
+warninglimit = 0