diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-03-04 17:31:17 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-03-05 15:55:19 +0100 |
| commit | dc8598ab1e441d9b49a3aac1e3812bf93f8a3211 (patch) | |
| tree | f87b882fcd3d3e4e8214a24e356c34fbd25dae84 /tests/auto/qdoc/generatedoutput/testdata | |
| parent | 60be58eb314349862e09d3fc106bfa23feda170f (diff) | |
qdoc: Fix issues in HelpProjectWriter
The code that generates Qt Help Project (.qhp) xml files was suffering
from multiple issues - mostly related to changes in Node inheritance
that were not reflected in HelpProjectWriter implementation.
- We no longer have subtypes for page nodes. Therefore, selectors like
'doc:example' were broken. Simplify the selector code but continue
supporting the old notation.
- Examples and basic QML/JS types were incorrectly dropped from the TOC.
- Node::Union and Node::Struct were called 'Class' in the .qhp. Use the
Generator::typeString() to fetch the correct type name for all types.
- Require .qhp subprojects to have at least a title to avoid empty
subsections in the TOC.
Add a test that covers the entire .qhp generation with different types
of subprojects defined.
Fixes: QTBUG-82671
Fixes: QTBUG-82674
Change-Id: I8fe4a8ad5fc6d58f86e0e9128e98c0b8c4ba4a6a
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/testdata')
| -rw-r--r-- | tests/auto/qdoc/generatedoutput/testdata/configs/examples-qhp.qdocconf | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/examples-qhp.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/examples-qhp.qdocconf index b4598476e..a1ed619a3 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/configs/examples-qhp.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/examples-qhp.qdocconf @@ -1,5 +1,6 @@ # QML test includes a documented example include(testqml.qdocconf) +version = 0.0.1 examplesinstallpath = test @@ -12,6 +13,22 @@ qhp.Test.virtualFolder = test qhp.Test.indexTitle = UI Components qhp.Test.indexRoot = +qhp.Test.subprojects = test classes qmltypes undefined +qhp.Test.subprojects.test.title = Test +qhp.Test.subprojects.test.indexTitle = UI Components +qhp.Test.subprojects.test.selectors = doc:page fake:example module qmlmodule +qhp.Test.subprojects.test.sortPages = true + +qhp.Test.subprojects.classes.title = Classes +qhp.Test.subprojects.classes.indexTitle = QDoc Test C++ Classes +qhp.Test.subprojects.classes.selectors = class namespace doc:headerfile boop:whatever +qhp.Test.subprojects.classes.sortPages = true + +qhp.Test.subprojects.qmltypes.title = QML Types +qhp.Test.subprojects.qmltypes.indexTitle = UI Components +qhp.Test.subprojects.qmltypes.selectors = qmlmodule:UIComponents,QDoc.Test +qhp.Test.subprojects.qmltypes.sortPages = true + # Add some meta-data to the example manifestmeta.filters = test |