diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-06-26 22:16:55 +0000 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2023-06-27 10:44:47 +0000 |
| commit | cfcc109e7da3e7f0d6c504f0cca3236479de6c22 (patch) | |
| tree | e994362a6ac24325648d42d8140d62b32e1dddb4 | |
| parent | d337f194cf8b8d03d1d4002af31568f6b957a451 (diff) | |
Doc: Remove/adjust warninglimit .qdocconf variables
The most common limit for the maximum number of allowed documentation
warnings is zero. As all Qt module docs include() a common configuration
from qtbase, it's better to control the base warninglimit from a central
location in qtbase/doc/global.
This allows for a temporary increase of the limit across all modules as
needed - for example, when updating the QDoc binary that the CI
provisions to a version that introduces new types of documentation
warnings.
In qtmultimedia.qdocconf, use the += operator to increase the base
limit to account for known documentation warnings.
Task-number: QTBUG-113326
Change-Id: I2ea30898df41672daf01add4800a401b4294ba77
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| -rw-r--r-- | src/multimedia/doc/qtmultimedia.qdocconf | 2 | ||||
| -rw-r--r-- | src/spatialaudio/doc/qtspatialaudio.qdocconf | 3 |
2 files changed, 1 insertions, 4 deletions
diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index 390db4790..e89629d54 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -78,6 +78,6 @@ navigation.qmltypespage = "Qt Multimedia QML Types" # Fail the documentation build if there are more warnings than the limit -warninglimit = 2 +warninglimit += 2 # examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc:4: (qdoc) warning: Missing image: qml-declarative-portrait.png # examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc:4: (qdoc) warning: Missing image: FlashControls.png diff --git a/src/spatialaudio/doc/qtspatialaudio.qdocconf b/src/spatialaudio/doc/qtspatialaudio.qdocconf index ec29c282b..3c8916907 100644 --- a/src/spatialaudio/doc/qtspatialaudio.qdocconf +++ b/src/spatialaudio/doc/qtspatialaudio.qdocconf @@ -60,6 +60,3 @@ ignoresince = 6.4 navigation.landingpage = "Qt Spatial Audio" navigation.cppclassespage = "Qt Spatial Audio C++ Classes" navigation.qmltypespage = "Qt Spatial Audio QML Types" - -# Fail the documentation build if there are more warnings than the limit -warninglimit = 0 |