diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2020-04-22 16:31:56 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2020-09-04 17:16:06 +0200 |
| commit | f370f85878391bc5c51db8473c33304080e003b9 (patch) | |
| tree | 6f7391297a031aed2fe45d695b65df739aa640b7 /tests/auto/qdoc/generatedoutput/testdata | |
| parent | a5adf455e66f210d54069f976780f2f9695ffc8f (diff) | |
QDoc: Warn about missing example properties
[ChangeLog][qdoc] QDoc now warns about missing example properties.
Fixes: QTBUG-37648
Change-Id: I0ab857e71ae3449ee976dc57e09b82d14d47fb0f
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/testdata')
7 files changed, 11 insertions, 2 deletions
diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/config.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/config.qdocconf index 31775942b..34042c600 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/configs/config.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/config.qdocconf @@ -1,5 +1,8 @@ # Shared configuration for all tests +# images +imagedirs = ../images + # zero warning policy warninglimit = 0 warninglimit.enabled = true diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/testqml.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/testqml.qdocconf index cdd4829c2..0673d4891 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/configs/testqml.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/testqml.qdocconf @@ -21,3 +21,5 @@ examples.fileextensions = "*.qml *.cpp" macro.begincomment = "\\c{/*}" macro.QDocTestVer = "1.1" + +warninglimit += 1 diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/webxml_testqml.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/webxml_testqml.qdocconf index 8dbbfd860..537685700 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/configs/webxml_testqml.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/webxml_testqml.qdocconf @@ -1,3 +1,2 @@ -include(config.qdocconf) include(testqml.qdocconf) include(webxml.qdocconf) diff --git a/tests/auto/qdoc/generatedoutput/testdata/examples/demos/demo/doc/src/demo.qdoc b/tests/auto/qdoc/generatedoutput/testdata/examples/demos/demo/doc/src/demo.qdoc index 08b609126..de7160ee4 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/examples/demos/demo/doc/src/demo.qdoc +++ b/tests/auto/qdoc/generatedoutput/testdata/examples/demos/demo/doc/src/demo.qdoc @@ -29,4 +29,6 @@ /*! \example demos/demo \title Demo + \image leonardo-da-vinci.png + //! Icon made by Smashicons from www.flaticon.com */ diff --git a/tests/auto/qdoc/generatedoutput/testdata/images/leonardo-da-vinci.png b/tests/auto/qdoc/generatedoutput/testdata/images/leonardo-da-vinci.png Binary files differnew file mode 100644 index 000000000..854acb4ca --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/images/leonardo-da-vinci.png diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/cmaketest/doc/src/cmaketest.qdoc b/tests/auto/qdoc/generatedoutput/testdata/qml/cmaketest/doc/src/cmaketest.qdoc index 13767e147..e60f3b9e8 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/qml/cmaketest/doc/src/cmaketest.qdoc +++ b/tests/auto/qdoc/generatedoutput/testdata/qml/cmaketest/doc/src/cmaketest.qdoc @@ -29,4 +29,6 @@ /*! \example cmaketest \title CMake Example Project + \image leonardo-da-vinci.png + //! Icon made by Smashicons from www.flaticon.com */ diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc b/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc index 5813b1247..9ca0db891 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc +++ b/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc @@ -35,7 +35,8 @@ \meta tag {test,sample} \meta installpath tutorials - This example demonstrates one of the ways to document QML types. + This example demonstrates one of the ways to document QML types. It also + generates a warning about a missing example image, on purpose. In particular, there are sample types that are documented with QDoc commands comments. There are documentation comments for the QML types |
