diff options
author | Paul Wicking <paul.wicking@qt.io> | 2023-04-13 14:53:56 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2023-04-13 15:27:17 +0200 |
commit | c0cd634a320b7186e967e3b70fd41c57554d6399 (patch) | |
tree | bb508ef0c5003f253cb201208a430f5ecced30bd /tests/auto/qdoc/generatedoutput/testdata | |
parent | 3eb400c6ff46ea98deb1afa8894878923efd705a (diff) | |
download | qttools-c0cd634a320b7186e967e3b70fd41c57554d6399.tar.gz |
QDoc: Remove unused \qmltext | \endqmltext command pair
QDoc offers the `\qmltext` and `\endqmltext` command pairs, dating back
to sometime prior to when QDoc moved to qttools.git in 2015.
The commands have since been considered tags not to be handled
specifically when generating documentation. The commands have not been
documented.
Upon inspection of source code across Qt and its modules, no usage of
the commands have been found, with the exception of the generated
output test for QDoc itself.
Even though unused and considered "only tags", the `Generator`,
`HTMLGenerator`, and `DocBookGenerator` classes still implement methods
to handle them and generate output for them. The removal of the
commands therefore necessitates removal of the methods that deal with
them. As the command pair is unused, removing the related code is a way
to reduce the surface of QDoc's generator classes, making them slightly
better suited for testing. This also improves the maintainability of
QDoc.
This change thus removes the commands and the related `Atom`s, as well
as any method designed to deal with those `Atom`s. In addition, the
test data and expected output for the generated output test is modified
to accommodate the behavior change.
Fixes: QTBUG-112764
Change-Id: I2b0a57783ccdccd3e8c1693e6946ecf07777f3b6
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/testdata')
-rw-r--r-- | tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc | 4 |
1 files changed, 0 insertions, 4 deletions
diff --git a/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc b/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc index 99f23b722..53fe34666 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc +++ b/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc @@ -116,10 +116,6 @@ \dots - \qmltext - And if I knew qmltext, I guess this is where that would go. - \endqmltext - \caption This a caption \legalese |