diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-06-06 12:30:22 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-06-08 16:31:16 +0200 |
| commit | 58902fbd684d39191fbddf3ef5e917e709b38a68 (patch) | |
| tree | 930157c38ec390ad164bea408057a999b4ae73fc /tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html | |
| parent | 41c601103dd2fef14e59a120e142008f8e3e93cd (diff) | |
qdoc: Extend synopsis for detailed reference sections
Include \since information for detailed synopsis generation,
and allow duplication of qdoc comments for C++/QML nodes
on the condition that the extra comments contain no
body text, only meta-commands.
The use case is to have full status information in the
signature/section title, and allow additional meta-commands
for items that share a documentation comment.
/*!
\fn void A:foo()
\fn void A:foo(int i)
Shared documentation for overloads.
*/
/*!
\fn void A:foo(int i)
\since 2.0
*/
Extract the code for 'extra' synopsis into a new helper function
and use for both HTML and DocBook generators.
Fixes: QTBUG-55739
Fixes: QTBUG-82902
Change-Id: I6e797d3ce7bc7b02102bb949515f88e7a0fbe929
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 | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html index 7cadc89ff..085c5afef 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html @@ -73,9 +73,8 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <h2>Member Function Documentation</h2> <!-- $$$ --> <div class="fngroup"> -<h3 class="fn fngroupitem" id="overload"><a name="overload"></a><code>[protected] </code><span class="type">void</span> Test::<span class="name">overload</span>()</h3><h3 class="fn fngroupitem" id="overload-1"><a name="overload-1"></a><code>[protected] </code><span class="type">void</span> Test::<span class="name">overload</span>(<span class="type">bool</span> <i>b</i>)</h3></div> +<h3 class="fn fngroupitem" id="overload"><a name="overload"></a><code>[protected] </code><span class="type">void</span> Test::<span class="name">overload</span>()</h3><h3 class="fn fngroupitem" id="overload-1"><a name="overload-1"></a><code>[protected, since Test 1.2] </code><span class="type">void</span> Test::<span class="name">overload</span>(<span class="type">bool</span> <i>b</i>)</h3></div> <p>Overloads that share a documentation comment, optionally taking a parameter <i>b</i>.</p> -<p>This function was introduced in Test 1.2.</p> <!-- @@@ --> <!-- $$$inlineFunction[overload1]$$$inlineFunction --> <h3 class="fn" id="inlineFunction"><a name="inlineFunction"></a><span class="type">void</span> Test::<span class="name">inlineFunction</span>()</h3> @@ -97,7 +96,7 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <div class="macros"> <h2>Macro Documentation</h2> <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2 --> -<h3 class="fn" id="QDOCTEST_MACRO2"><a name="QDOCTEST_MACRO2"></a><span class="name">QDOCTEST_MACRO2</span>(<i>x</i>)</h3> +<h3 class="fn" id="QDOCTEST_MACRO2"><a name="QDOCTEST_MACRO2"></a><code>[since Test 1.1] </code><span class="name">QDOCTEST_MACRO2</span>(<i>x</i>)</h3> <p>A macro with argument <i>x</i>.</p> <p>This function was introduced in Test 1.1.</p> <!-- @@@QDOCTEST_MACRO2 --> |