diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-03-11 15:38:02 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-03-14 23:03:16 +0100 |
| commit | bfdbcf2a5800889ae57717899eaeb8e998a68eb2 (patch) | |
| tree | 6938da051602c3b8a4c5fd26f33dabc890afa029 /tests/auto/qdoc/generatedoutput/testdata | |
| parent | ee49537f31aff32fa674292d3d413d8d40f661a7 (diff) | |
qdoc: Expand \noautolist to cover also C++ module pages
Even though the \noautolist has been documented to work for C++ module
pages, using it within \module documentation had no effect. Generate
the list of namespaces and classes only if \noautolist does not appear
on the module page.
Add a test for \noautolist, for both HTML and DocBook generators.
Fixes: QTBUG-82822
Change-Id: I27dcdafaa44981f18d08f2f27a148a1febba2d8a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/testdata')
5 files changed, 20 insertions, 0 deletions
diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/noautolist.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/noautolist.qdocconf new file mode 100644 index 000000000..fc720c57e --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/noautolist.qdocconf @@ -0,0 +1,13 @@ +include(testqml.qdocconf) +defines += test_noautolist + +outputformats = HTML DocBook + +HTML.nosubdirs = true +DocBook.nosubdirs = true +HTML.outputsubdir = noautolist +DocBook.outputsubdir = noautolist-docbook + +# TODO: DocBook generator has trouble handling shared comment nodes +# - allow two warnings related to these +warninglimit = 2 diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/testcpp.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/testcpp.qdocconf index b07aa71c0..7bb7810f1 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/configs/testcpp.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/testcpp.qdocconf @@ -6,6 +6,7 @@ sources = ../testcpp/testcpp.cpp macro.CMDFN = \\\\fn macro.nothing = \\dontdocument () +macro.testnoautolist = \\if defined(test_noautolist)\n\\noautolist\n\\endif locationinfo = false # zero warning tolerance diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc b/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc index 0816e624c..bce12a4ae 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc +++ b/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc @@ -30,6 +30,8 @@ \title QML Documentation Example \brief Example for documenting QML types. + \testnoautolist + \meta tag {test,sample} \meta installpath tutorials diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp index bf04bdb43..2e967c4a2 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp +++ b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp @@ -31,6 +31,8 @@ /*! \qmlmodule QDoc.Test \QDocTestVer \brief QML Types for the Test module. + + \testnoautolist */ /*! diff --git a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp index b1acdccf0..8422494ac 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp +++ b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp @@ -34,6 +34,8 @@ namespace TestQDoc { \qtvariable testcpp \title QDoc Test C++ Classes \brief A test module page. + + \testnoautolist */ /*! |