diff options
author | Topi Reinio <topi.reinio@qt.io> | 2020-04-21 23:57:46 +0200 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2020-04-23 10:19:54 +0200 |
commit | e967772fe884dd8a488a359c122c9cbae9d94c55 (patch) | |
tree | 570c6bb5f46ef5409f4508a746dbde4542f7d7a9 /tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml | |
parent | 95cd9078938bcd88fdfbba707911e8111f59f195 (diff) |
qdoc: properly implement \typealias command
\typealias was already a command recognized by QDoc, but it was simply
treated as a synonym for \typedef and was not documented. Implement
proper support for the command:
- Add [alias] designation both in type summary and details.
- Auto-generate information about the aliased type, including a link
if aliasing a public, documented type.
- Auto-convert aliases documented with \typedef to type aliases.
- Add basic support for aliases also to DocBook and WebXML generators.
- Document \typealias.
Fixes: QTBUG-82712
Change-Id: Iafa8c7def0a7488d7521fbc2862290a9bb3167ff
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/expected_output/docbook/testqdoc-testderived.xml')
-rw-r--r-- | tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml index 9bb613cfc..ced1bea5b 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml @@ -32,6 +32,31 @@ <db:section xml:id="details"> <db:title>Detailed Description</db:title> </db:section> +<db:section xml:id="member-type-documentation"> +<db:title>Member Type Documentation</db:title> +<db:section xml:id="DerivedType-alias"> +<db:title>[alias] TestDerived::DerivedType</db:title> +<db:typedefsynopsis> +<db:type>DerivedType</db:type><db:synopsisinfo db:role="access">public</db:synopsisinfo> +<db:synopsisinfo db:role="status">active</db:synopsisinfo> +<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo> +<db:synopsisinfo db:role="module">TestCPP</db:synopsisinfo> +</db:typedefsynopsis> +<db:para>This is a type alias for <db:link xlink:href="testqdoc-test.xml#SomeType-typedef">TestQDoc::Test::SomeType</db:link>.</db:para> +<db:para>An aliased typedef.</db:para> +</db:section> +<db:section xml:id="NotTypedef-alias"> +<db:title>[alias] TestDerived::NotTypedef</db:title> +<db:typedefsynopsis> +<db:type>NotTypedef</db:type><db:synopsisinfo db:role="access">public</db:synopsisinfo> +<db:synopsisinfo db:role="status">active</db:synopsisinfo> +<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo> +<db:synopsisinfo db:role="module">TestCPP</db:synopsisinfo> +</db:typedefsynopsis> +<db:para>This is a type alias for <db:code>int</db:code>.</db:para> +<db:para>I'm an alias, not a typedef.</db:para> +</db:section> +</db:section> <db:section xml:id="member-function-documentation"> <db:title>Member Function Documentation</db:title> <db:section xml:id="virtualFun"> |