diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-05-15 00:09:04 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-05-19 09:25:52 +0200 |
| commit | f904f727588f5480eda7396569569c9a27310092 (patch) | |
| tree | f067cbeb34b255ee76280e29cc41d8daef39918a /tests/auto/qdoc/generatedoutput/testdata | |
| parent | 2495c48a93fe0771ee59777a47071d19062d9e4a (diff) | |
qdoc: Introduce automatic generation of navigation links
Introduce a new configuration variable, navigation.toctitles, for
automatic generation of navigation links for pages listed in a TOC.
A TOC page is a \page with a \list, where list elements define the pages
included in the documentation set. When set, QDoc will generate links
for these pages, without the need for \nextpage and \previouspage
commands.
[ChangeLog][qdoc] Added a capability to generate navigation links for
pages listed in a TOC.
Fixes: QTBUG-84238
Change-Id: I0b34d8a0fe4b01a2ffcc084e6416c0a4b4623b78
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/testdata')
3 files changed, 32 insertions, 1 deletions
diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/test.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/test.qdocconf index f1ab7ec2e..bcc5c0926 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/configs/test.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/test.qdocconf @@ -7,6 +7,9 @@ sources = ../outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc macro.beginqdoc = "\\c {/*!}" macro.endqdoc = "\\c */" +macro.PROD = QDoc + +defines = test_navigation # zero warning tolerance warninglimit = 0 diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/tocnavigation.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/tocnavigation.qdocconf new file mode 100644 index 000000000..69e0dfac2 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/tocnavigation.qdocconf @@ -0,0 +1,4 @@ +include(test.qdocconf) + +defines = +navigation.toctitles = "Table of Contents" diff --git a/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc b/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc index e56c447c4..36d85fb35 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc +++ b/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc @@ -26,8 +26,12 @@ ****************************************************************************/ /*! +\if defined(test_navigation) + \nextpage {qdoctests-qdocfileoutput-linking.html}{QDoc Linking Test} +\endif + \page qdoctests-qdocfileoutput.html - \title Testing QDoc output from .qdoc files + \title Testing \PROD output from .qdoc files \brief This is a simple page for testing purposes only. QDoc generates documentation for software projects. It does this by @@ -69,6 +73,11 @@ */ /*! +\if defined(test_navigation) + \previouspage qdoctests-qdocfileoutput.html \PROD Testing + \nextpage Table of Contents +\endif + \keyword QDoc Linking Test \page qdoctests-qdocfileoutput-linking.html \title Testing QDoc's link command @@ -81,3 +90,18 @@ titles, targets defined with \\target or \\keyword commands, and API reference keywords (types, methods, namespaces, and so on). */ + +/*! +\if defined(test_navigation) + \previouspage {Testing QDoc's link command}{QDoc Linking Test} +\endif + + \page toc.html + \title Table of Contents + + \list + \li \l {Testing \PROD output from .qdoc files}{\PROD Testing} + \li \l {QDoc Linking Test} + \li \l {Table of Contents} + \endlist +*/ |