diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2022-07-14 14:44:45 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2022-07-15 14:38:11 +0200 |
| commit | 214521bf8dbf477949373fc2fbbf3ebe5dc1de37 (patch) | |
| tree | 1147ede0754c4af65f58f7a191b9f346e321ebe4 /tests | |
| parent | 5b71a876062cac429042affb9432f2db86a91aa7 (diff) | |
| download | qttools-214521bf8dbf477949373fc2fbbf3ebe5dc1de37.tar.gz | |
qdoc: Introduce \modulestate command
This command can be used in \module or \qmlmodule topic to describe a
module state other than \preliminary or \deprecated. A typical use case
is to mark modules in tech. preview:
/*!
\module QFoo
\modulestate Techical Preview
...
*/
This information is displayed on the module page itself, as well as
on the navigation bar of the module's member reference pages.
Introduce a new function, QDocDatabase::getModuleNode() that retrieves
the associated module node for any other Node instance. Use this
in HtmlGenerator::generateNavigation() and also in Tree::resolveSince()
to avoid code duplication.
Fixes: QTBUG-104591
Change-Id: Ifd85e769f6df6f06ed9938da4f9981b22a56e19e
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Diffstat (limited to 'tests')
5 files changed, 6 insertions, 2 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/test-nover-qmlmodule.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/test-nover-qmlmodule.xml index 7a3138cca..1cd079200 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/test-nover-qmlmodule.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/test-nover-qmlmodule.xml @@ -6,9 +6,11 @@ <db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> <db:abstract> <db:para>QML Types for the Test module without version.</db:para> +<db:para>This module is in <db:emphasis>Tech Preview</db:emphasis> state.</db:para> <db:para>This module was introduced in Qt 1.1.</db:para> </db:abstract> </db:info> +<db:para>This module is in <db:emphasis>Tech Preview</db:emphasis> state.</db:para> <db:para>This module was introduced in Qt 1.1.</db:para> <db:anchor xml:id="details"/> <db:variablelist role="members"> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-test-nover-typenoversion-members.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-test-nover-typenoversion-members.html index 96ef55fea..f4ce83a17 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-test-nover-typenoversion-members.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-test-nover-typenoversion-members.html @@ -7,7 +7,7 @@ </head> <body> <li><a href="qdoc-test-qmlmodule.html">Types</a></li> -<li><a href="test-nover-qmlmodule.html">Test.NoVer</a></li> +<li><a href="test-nover-qmlmodule.html">Test.NoVer (Tech Preview)</a></li> <li>TypeNoVersion</li> <div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">List of All Members for TypeNoVersion</h1> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-test-nover-typenoversion.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-test-nover-typenoversion.html index a312f0460..311e8b69d 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-test-nover-typenoversion.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-test-nover-typenoversion.html @@ -7,7 +7,7 @@ </head> <body> <li><a href="qdoc-test-qmlmodule.html">Types</a></li> -<li><a href="test-nover-qmlmodule.html">Test.NoVer</a></li> +<li><a href="test-nover-qmlmodule.html">Test.NoVer (Tech Preview)</a></li> <li>TypeNoVersion</li> <div class="sidebar"> <div class="toc"> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/test-nover-qmlmodule.html b/tests/auto/qdoc/generatedoutput/expected_output/test-nover-qmlmodule.html index 0bb01efdf..499846f86 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/test-nover-qmlmodule.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/test-nover-qmlmodule.html @@ -8,6 +8,7 @@ <body> <div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">Versionless QML Module</h1> +<p>This module is in <i>Tech Preview</i> state.</p> <p>This module was introduced in Qt 1.1.</p> <!-- $$$Test.NoVer-description --> <div class="descr" id="details"> diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp index 02632b6df..f0d913853 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp +++ b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp @@ -24,6 +24,7 @@ \title Versionless QML Module \brief QML Types for the Test module without version. \since 1.1 + \modulestate Tech Preview */ /*! |