diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-10-15 11:19:12 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-11-09 23:30:45 +0100 |
| commit | 4cdcfe335eba1142c6b9a56408b88caa6660974c (patch) | |
| tree | b0f835a83305d6826e67101cf300bd7c28d2b404 /tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html | |
| parent | 12f8258efcab39a571df4cbb8cacf5bfc2eb8a82 (diff) | |
qdoc: Unify generated documentation between \typedef and \typealias
\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ö <topi.reinio@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html')
| -rw-r--r-- | tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html index fb2226e51..8ff9001b5 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html @@ -36,7 +36,7 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <a name="public-types"></a> <h2 id="public-types">Public Types</h2> <div class="table"><table class="alignedsummary"> -<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#SomeType-typedef">SomeType</a></b></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#SomeType-typedef">SomeType</a></b></td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> @@ -74,7 +74,7 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$SomeType --> -<h3 class="fn" id="SomeType-typedef"><a name="SomeType-typedef"></a>typedef Test::<span class="name">SomeType</span></h3> +<h3 class="fn" id="SomeType-typedef"><a name="SomeType-typedef"></a>Test::<span class="name">SomeType</span></h3> <p>A typedef.</p> <!-- @@@SomeType --> </div> |