diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-04-21 07:40:43 +0000 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2023-04-24 18:39:40 +0000 |
| commit | 34d28f769f87ff876748e1db3e7bf12ec04d4ff7 (patch) | |
| tree | 8eece54047855e2f2664fa2e7e5b69f941d46d07 /tests | |
| parent | 046447a6fa686ed076a7df8d27b00abe0811750b (diff) | |
| download | qttools-34d28f769f87ff876748e1db3e7bf12ec04d4ff7.tar.gz | |
qdoc: Allow custom status descriptions for C++, QML types
QDoc already allows defining a custom status for C++ and QML modules
via the \modulestate command. In Qt, this is typically used for
marking a module and its types with 'Technology preview' status.
Allow a custom status for individual types as well, with
\meta {status} {<description>} command. This information is added
to the 'Requisites' table on top of the type reference page.
Document the new status argument for \meta, and update its
documentation as it contained obsolete information.
Pick-to: 6.5
Task-number: QTBUG-113026
Change-Id: I5a13aa8650b6e188ffe50a1e948da90474bfb7a0
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Diffstat (limited to 'tests')
3 files changed, 8 insertions, 1 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml index b311f505b..4422b6962 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml @@ -28,6 +28,12 @@ <db:para><db:link xlink:href="testqdoc-test.xml">Test</db:link></db:para> </db:listitem> </db:varlistentry> +<db:varlistentry> +<db:term>Status:</db:term> +<db:listitem> +<db:para><Work In Progress></db:para> +</db:listitem> +</db:varlistentry> </db:variablelist> <db:section xml:id="details"> <db:title>Detailed Description</db:title> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html index 389c81b97..d928fbf18 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html @@ -27,7 +27,7 @@ <p>A QML type documented in a .cpp file. <a href="#details">More...</a></p> <!-- @@@Type --> <div class="table"><table class="alignedsummary" translate="no"> -<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-test.html" translate="no">Test</a></td></tr></table></div><ul> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-test.html" translate="no">Test</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Status:</td><td class="memItemRight bottomAlign"> <Work In Progress><span class="status work-in-progress"></span></td></tr></table></div><ul> <li><a href="qml-qdoc-test-type-members.html">List of all members, including inherited members</a></li> <li><a href="qml-qdoc-test-type-obsolete.html">Deprecated members</a></li> </ul> diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp index 8e4d6e677..f3c9546b8 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp +++ b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp @@ -32,6 +32,7 @@ \instantiates TestQDoc::Test \inqmlmodule QDoc.Test \brief A QML type documented in a .cpp file. + \meta status { <Work In Progress> } */ /*! |