From 4cdcfe335eba1142c6b9a56408b88caa6660974c Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Thu, 15 Oct 2020 11:19:12 +0200 Subject: qdoc: Unify generated documentation between \typedef and \typealias MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit \typedef can be used as a substitute for \typealias for documenting aliases. Since they are identical in terms of usage, unify also the way they are documented: - Remove 'typedef' and '(alias)' from both the summary and details sections, making both appear as types. - Remove automatically generated 'This is a type alias for ...' note for type aliases. This typically resulted in duplicate statements. - Use '-typedef' anchor suffix for both. - Use 'typedef' as element for both in .index files and webxml output format. - Add template parameters for type aliases for DocBook generator; these were previously missing. Fixes: QTBUG-87622 Change-Id: I93986a2dc91c3c3dff9e21f5bf5cf19d0b55c4df Reviewed-by: Topi Reiniƶ --- .../expected_output/crossmodule/testtype-members.html | 6 +++--- .../generatedoutput/expected_output/docbook/testqdoc-test.xml | 2 +- .../expected_output/docbook/testqdoc-testderived.xml | 6 ++---- .../expected_output/dontdocument/dontdocument.qhp | 4 ++-- .../expected_output/html/testqdoc-testderived.webxml | 8 ++++---- .../expected_output/ignoresince/testqdoc-test.html | 4 ++-- .../properties-docbook/testqdoc-testderived.xml | 6 ++---- .../generatedoutput/expected_output/properties/testcpp.index | 4 ++-- .../properties/testqdoc-testderived-members.html | 6 +++--- .../expected_output/properties/testqdoc-testderived.html | 10 ++++------ .../expected_output/scopedenum-docbook/testqdoc-test.xml | 2 +- .../expected_output/scopedenum/testqdoc-test.html | 4 ++-- .../expected_output/template/testqdoc-test.html | 9 ++++----- tests/auto/qdoc/generatedoutput/expected_output/test.qhp | 4 ++-- tests/auto/qdoc/generatedoutput/expected_output/testcpp.index | 4 ++-- .../generatedoutput/expected_output/testqdoc-test-members.html | 2 +- .../qdoc/generatedoutput/expected_output/testqdoc-test.html | 4 ++-- .../expected_output/testqdoc-testderived-members.html | 6 +++--- .../generatedoutput/expected_output/testqdoc-testderived.html | 10 ++++------ .../auto/qdoc/generatedoutput/expected_output/testtagfile.tags | 4 ++-- 20 files changed, 48 insertions(+), 57 deletions(-) (limited to 'tests') diff --git a/tests/auto/qdoc/generatedoutput/expected_output/crossmodule/testtype-members.html b/tests/auto/qdoc/generatedoutput/expected_output/crossmodule/testtype-members.html index 889ba1438..0a32e4e60 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/crossmodule/testtype-members.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/crossmodule/testtype-members.html @@ -11,9 +11,9 @@

List of All Members for TestType

This is the complete list of members for TestType, including inherited members.