summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-05-07 13:18:42 +0200
committerQt Cherry-pick Bot <cherrypickbot@codereview.qt-project.org>2020-05-12 03:46:56 +0000
commit469202bcce523ac613449b02cd82cfa73c025a1e (patch)
treecd036ee3f428e46ef3ec3c59c970a6a46af64643
parent87a862817ccdabb3f7c0e34a2b27c94663e3a1f8 (diff)
qdoc: Output status and since information for all modules
Previously, output for commands like \preliminary and \since was generated only for C++ modules. Extend this to apply also to QML and JS modules. Fixes: QTBUG-65963 Change-Id: I4c2eb87692be11495265523c31ba4f9885f29f0c Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit c21ea2f13eae86958caf7e80a60a74fe182aaa7e) Reviewed-by: Qt Cherry-pick Bot
-rw-r--r--src/qdoc/docbookgenerator.cpp14
-rw-r--r--src/qdoc/htmlgenerator.cpp12
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoc-test-qmlmodule.xml4
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/noautolist-docbook/qdoc-test-qmlmodule.xml4
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/noautolist/qdoc-test-qmlmodule.html2
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/qdoc-test-qmlmodule.html2
-rw-r--r--tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc2
-rw-r--r--tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp2
8 files changed, 30 insertions, 12 deletions
diff --git a/src/qdoc/docbookgenerator.cpp b/src/qdoc/docbookgenerator.cpp
index f6476c9ec..e463a6b45 100644
--- a/src/qdoc/docbookgenerator.cpp
+++ b/src/qdoc/docbookgenerator.cpp
@@ -4101,13 +4101,16 @@ void DocBookGenerator::generateCollectionNode(CollectionNode *cn)
// Element synopsis.
generateDocBookSynopsis(cn);
- // Actual content.
- if (cn->isModule()) {
- // Generate brief text and status for modules.
- generateBrief(cn);
+ // Generate brief for C++ modules, status for all modules.
+ if (cn->genus() != Node::DOC && cn->genus() != Node::DontCare) {
+ if (cn->isModule())
+ generateBrief(cn);
generateStatus(cn);
generateSince(cn);
+ }
+ // Actual content.
+ if (cn->isModule()) {
if (!cn->noAutoList()) {
NodeMultiMap nmm;
cn->getMemberNamespaces(nmm);
@@ -4126,9 +4129,8 @@ void DocBookGenerator::generateCollectionNode(CollectionNode *cn)
}
}
- Text brief = cn->doc().briefText();
bool generatedTitle = false;
- if (cn->isModule() && !brief.isEmpty()) {
+ if (cn->isModule() && !cn->doc().briefText().isEmpty()) {
startSection(registerRef("details"), "Detailed Description");
generatedTitle = true;
} else {
diff --git a/src/qdoc/htmlgenerator.cpp b/src/qdoc/htmlgenerator.cpp
index ed130aaf8..b99c30224 100644
--- a/src/qdoc/htmlgenerator.cpp
+++ b/src/qdoc/htmlgenerator.cpp
@@ -1631,12 +1631,15 @@ void HtmlGenerator::generateCollectionNode(CollectionNode *cn, CodeMarker *marke
generateKeywordAnchors(cn);
generateTitle(fullTitle, Text() << cn->subtitle(), subTitleSize, cn, marker);
- if (cn->isModule()) {
- // Generate brief text and status for modules.
- generateBrief(cn, marker);
+ // Generate brief for C++ modules, status for all modules.
+ if (cn->genus() != Node::DOC && cn->genus() != Node::DontCare) {
+ if (cn->isModule())
+ generateBrief(cn, marker);
generateStatus(cn, marker);
generateSince(cn, marker);
+ }
+ if (cn->isModule()) {
if (!cn->noAutoList()) {
NodeMultiMap nmm;
cn->getMemberNamespaces(nmm);
@@ -1657,8 +1660,7 @@ void HtmlGenerator::generateCollectionNode(CollectionNode *cn, CodeMarker *marke
}
}
- Text brief = cn->doc().briefText();
- if (cn->isModule() && !brief.isEmpty()) {
+ if (cn->isModule() && !cn->doc().briefText().isEmpty()) {
generateExtractionMark(cn, DetailedDescriptionMark);
ref = registerRef("details");
out() << "<a name=\"" << ref << "\"></a>" << divNavTop << '\n';
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoc-test-qmlmodule.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoc-test-qmlmodule.xml
index 1629830f9..dfe6c3b6e 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoc-test-qmlmodule.xml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoc-test-qmlmodule.xml
@@ -6,8 +6,12 @@
<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev>
<db:abstract>
<db:para>QML Types for the Test module.</db:para>
+<db:para><db:emphasis role="bold">This module is under development and is subject to change.</db:emphasis></db:para>
+<db:para>This module was introduced in Qt 1.1.</db:para>
</db:abstract>
</db:info>
+<db:para><db:emphasis role="bold">This module is under development and is subject to change.</db:emphasis></db:para>
+<db:para>This module was introduced in Qt 1.1.</db:para>
<db:anchor xml:id="details"/>
<db:variablelist role="members">
<db:varlistentry>
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/noautolist-docbook/qdoc-test-qmlmodule.xml b/tests/auto/qdoc/generatedoutput/expected_output/noautolist-docbook/qdoc-test-qmlmodule.xml
index b99e58480..8934e4729 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/noautolist-docbook/qdoc-test-qmlmodule.xml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/noautolist-docbook/qdoc-test-qmlmodule.xml
@@ -6,7 +6,11 @@
<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev>
<db:abstract>
<db:para>QML Types for the Test module.</db:para>
+<db:para><db:emphasis role="bold">This module is under development and is subject to change.</db:emphasis></db:para>
+<db:para>This module was introduced in Qt 1.1.</db:para>
</db:abstract>
</db:info>
+<db:para><db:emphasis role="bold">This module is under development and is subject to change.</db:emphasis></db:para>
+<db:para>This module was introduced in Qt 1.1.</db:para>
<db:anchor xml:id="details"/>
</db:article>
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/noautolist/qdoc-test-qmlmodule.html b/tests/auto/qdoc/generatedoutput/expected_output/noautolist/qdoc-test-qmlmodule.html
index 8efd70c0f..9a1d8b329 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/noautolist/qdoc-test-qmlmodule.html
+++ b/tests/auto/qdoc/generatedoutput/expected_output/noautolist/qdoc-test-qmlmodule.html
@@ -8,6 +8,8 @@
<body>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<span class="subtitle"></span>
+<p><b>This module is under development and is subject to change.</b></p>
+<p>This module was introduced in Qt 1.1.</p>
<!-- $$$QDoc.Test-description -->
<div class="descr"> <a name="details"></a>
</div>
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qdoc-test-qmlmodule.html b/tests/auto/qdoc/generatedoutput/expected_output/qdoc-test-qmlmodule.html
index 6a513e987..734447216 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/qdoc-test-qmlmodule.html
+++ b/tests/auto/qdoc/generatedoutput/expected_output/qdoc-test-qmlmodule.html
@@ -8,6 +8,8 @@
<body>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<span class="subtitle"></span>
+<p><b>This module is under development and is subject to change.</b></p>
+<p>This module was introduced in Qt 1.1.</p>
<!-- $$$QDoc.Test-description -->
<div class="descr"> <a name="details"></a>
</div>
diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc b/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc
index bce12a4ae..5813b1247 100644
--- a/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc
+++ b/tests/auto/qdoc/generatedoutput/testdata/qml/componentset/examples.qdoc
@@ -93,7 +93,7 @@
/*!
\qmlmodule UIComponents 1.0
\title UI Components
- \brief Basic set of UI components
+ \brief Basic set of UI components.
This is a listing of a list of UI components implemented by QML types. These
files are available for general import and they are based on the
diff --git a/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp b/tests/auto/qdoc/generatedoutput/testdata/qml/type.cpp
index 2e967c4a2..2ae71fece 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.
+ \since 1.1
+ \preliminary
\testnoautolist
*/