From 2ba87cd00e6527dbd64f5884f29081bd535605bb Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Thu, 30 Mar 2023 09:09:26 +0000 Subject: qdoc: Fix links in \generatelist output The \generatelist command already supported listing members of a group as a simple unordered list of titles/links, but the links were broken as they always referred to the current document. In DocBook generator, reuse generateAnnotatedList() for this purpose as it already has support for outputting simple itemized/unordered lists. Create a new private enum GeneratedListType to select the list 'subtype' and clean up the API. Add simple test case and documentation of the new argument. Fixes: QTBUG-111575 Pick-to: 6.5 Change-Id: I30e4976cef3b6aa5414aac457844ae5bc0762f3d Reviewed-by: Paul Wicking --- .../generatedoutput/expected_output/cpptypes.html | 24 +++++++++++++++++ .../expected_output/docbook/cpptypes.xml | 30 ++++++++++++++++++++++ .../testdata/testcpp/classlists.qdoc | 2 ++ .../qdoc/generatedoutput/tst_generatedoutput.cpp | 2 ++ 4 files changed, 58 insertions(+) create mode 100644 tests/auto/qdoc/generatedoutput/expected_output/cpptypes.html create mode 100644 tests/auto/qdoc/generatedoutput/expected_output/docbook/cpptypes.xml (limited to 'tests') diff --git a/tests/auto/qdoc/generatedoutput/expected_output/cpptypes.html b/tests/auto/qdoc/generatedoutput/expected_output/cpptypes.html new file mode 100644 index 000000000..633ca939b --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/cpptypes.html @@ -0,0 +1,24 @@ + + + + + + Test C++ Types | TestCPP + + + +

Test C++ Types

+ +

TestQDoc::Test

A class in a namespace

+ + diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/cpptypes.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/cpptypes.xml new file mode 100644 index 000000000..9dcabf364 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/cpptypes.xml @@ -0,0 +1,30 @@ + + + +Test C++ Types +TestCPP +TestCPP Reference Documentation + +TestCPP Reference Documentation. + + + + +TestQDoc::Test + + +TestQDoc::Test::QDOCTEST_MACRO2 + + +TestQDoc::Test::someFunctionDefaultArg() + + + + +TestQDoc::Test + +A class in a namespace. + + + + diff --git a/tests/auto/qdoc/generatedoutput/testdata/testcpp/classlists.qdoc b/tests/auto/qdoc/generatedoutput/testdata/testcpp/classlists.qdoc index 0a40e9b3e..8f6e9b6b7 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/testcpp/classlists.qdoc +++ b/tests/auto/qdoc/generatedoutput/testdata/testcpp/classlists.qdoc @@ -38,4 +38,6 @@ /*! \group cpptypes \title Test C++ Types + + \generatelist testgroup */ diff --git a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp index 69d930ff4..552ed39cc 100644 --- a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp +++ b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp @@ -222,6 +222,7 @@ void tst_generatedOutput::htmlFromCpp() "testqdoc-testderived-obsolete.html " "obsolete-classes.html " "autolinking.html " + "cpptypes.html " "testqdoc.html"); } @@ -315,6 +316,7 @@ void tst_generatedOutput::docBookFromCpp() "docbook/testcpp-module.xml " "docbook/testqdoc-test.xml " "docbook/testqdoc-testderived.xml " + "docbook/cpptypes.xml " "docbook/testqdoc.xml"); } -- cgit v1.2.1