diff options
| author | Nicholas Bennett <nicholas.bennett@qt.io> | 2022-01-14 12:26:32 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-01-17 18:34:13 +0000 |
| commit | 98a3819749feddbc8543b25f72937aa82205190a (patch) | |
| tree | a98a731c4c67c3c27052071aa20bb9be5538db88 | |
| parent | c3f441a36a76532753762bf0a27802aff5574f47 (diff) | |
Docs: Fix any renaming warnings and enable doc CI test/ warning limit
In order to prevent future rework of the multimedia docs and improve
the quality of submissions:
-Updated the coin yaml file to include the doc test.
-Updated the qdoccconf and set qdoc warning limit to 0.
-Fixed the remaining qdoc warnings.
Change-Id: I04f1449f9c403dd75d5612fe8d65b7019b1903b9
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
(cherry picked from commit 6a3693fafa94053b75250bcfd26ebb3e19edb85e)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | coin/module_config.yaml | 3 | ||||
| -rw-r--r-- | src/multimedia/audio/qaudiodevice.cpp | 2 | ||||
| -rw-r--r-- | src/multimedia/camera/qcameradevice.cpp | 2 | ||||
| -rw-r--r-- | src/multimedia/doc/qtmultimedia.qdocconf | 3 |
4 files changed, 7 insertions, 3 deletions
diff --git a/coin/module_config.yaml b/coin/module_config.yaml index 6c1ee3f7b..7733000cb 100644 --- a/coin/module_config.yaml +++ b/coin/module_config.yaml @@ -8,4 +8,5 @@ instructions: Build: - !include "{{qt/qtbase}}/coin_module_build_template_v2.yaml" - Test: [] + Test: + - !include "{{qt/qtbase}}/coin_module_test_docs.yaml" diff --git a/src/multimedia/audio/qaudiodevice.cpp b/src/multimedia/audio/qaudiodevice.cpp index d180d4d53..23b97eca2 100644 --- a/src/multimedia/audio/qaudiodevice.cpp +++ b/src/multimedia/audio/qaudiodevice.cpp @@ -205,7 +205,7 @@ QByteArray QAudioDevice::id() const } /*! - \qmlmproperty string QtMultimedia::audioDevice::description + \qmlproperty string QtMultimedia::audioDevice::description Holds a human readable name of the audio device. diff --git a/src/multimedia/camera/qcameradevice.cpp b/src/multimedia/camera/qcameradevice.cpp index 760eb1667..5aadd4b79 100644 --- a/src/multimedia/camera/qcameradevice.cpp +++ b/src/multimedia/camera/qcameradevice.cpp @@ -376,7 +376,7 @@ QString QCameraDevice::description() const */ /*! - \qmlpropertyenumeration QtMultimedia::cameraDevice::position + \qmlproperty enumeration QtMultimedia::cameraDevice::position Returns the physical position of the camera on the hardware system. diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index 35319b0b4..58d56d618 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -69,3 +69,6 @@ ignoresince = 6.3 navigation.landingpage = "Qt Multimedia" navigation.cppclassespage = "Qt Multimedia C++ Classes" navigation.qmltypespage = "Qt Multimedia QML Types" + +# Fail the documentation build if there are more warnings than the limit +warninglimit = 0 |