diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2022-08-16 12:10:37 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-08-22 18:33:09 +0000 |
| commit | a253d8e30d5fb3a973f469c039d2165475a9c0d6 (patch) | |
| tree | ef1aa52105c8bc152a764aa301b89482b3344bf2 | |
| parent | 3264d78cb76ca76357a31a28c5f7914d3fa166a5 (diff) | |
doc: Handle macros while generating since info
The generator treated macros as a function/method, resulting
in a since entry that referred to the macro as a function.
In addition, updated test data to ensure that the since entry
for a \macro is tested.
Change-Id: I648511705babad84163bc3e0ebd8233c4d46f4e2
Fixes: QTBUG-105097
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit fffdb06383ff9aa29bcd1988cb19ca3e927bd224)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
7 files changed, 9 insertions, 6 deletions
diff --git a/src/qdoc/generator.cpp b/src/qdoc/generator.cpp index 5f65236f2..ffcf7b98f 100644 --- a/src/qdoc/generator.cpp +++ b/src/qdoc/generator.cpp @@ -2097,6 +2097,9 @@ QString Generator::typeString(const Node *node) case FunctionNode::JsMethod: case FunctionNode::QmlMethod: return "method"; + case FunctionNode::MacroWithParams: + case FunctionNode::MacroWithoutParams: + return "macro"; default: break; } diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml index 84da0fc1f..ddb1ed0e6 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml @@ -227,7 +227,7 @@ <db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo> </db:methodsynopsis> <db:para>A macro with argument <db:code role="parameter">x</db:code>.</db:para> -<db:para>This function was introduced in Test 1.1.</db:para> +<db:para>This macro was introduced in Test 1.1.</db:para> </db:section> </db:section> <db:section xml:id="obsolete"> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html index 4e8ac4e16..3393cb4d5 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html @@ -124,7 +124,7 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr><tr><td class="me <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> <h3 class="fn" id="QDOCTEST_MACRO2"><code>[since Test 1.1] </code><span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> <p>A macro with argument <i>x</i>.</p> -<p>This function was introduced in Test 1.1.</p> +<p>This macro was introduced in Test 1.1.</p> <!-- @@@QDOCTEST_MACRO2 --> </div> </body> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml index 48818cf44..8d12c1acc 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml @@ -324,7 +324,7 @@ <db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo> </db:methodsynopsis> <db:para>A macro with argument <db:code role="parameter">x</db:code>.</db:para> -<db:para>This function was introduced in Test 1.1.</db:para> +<db:para>This macro was introduced in Test 1.1.</db:para> </db:section> </db:section> <db:section xml:id="obsolete"> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html index 916dc7242..6edee36cc 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html @@ -142,7 +142,7 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr><tr><td class="me <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> <h3 class="fn" id="QDOCTEST_MACRO2"><code>[since Test 1.1] </code><span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> <p>A macro with argument <i>x</i>.</p> -<p>This function was introduced in Test 1.1.</p> +<p>This macro was introduced in Test 1.1.</p> <!-- @@@QDOCTEST_MACRO2 --> </div> </body> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html index 6c11a75c0..f900f30ba 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html @@ -133,7 +133,7 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr><tr><td class="me <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> <h3 class="fn" id="QDOCTEST_MACRO2"><code>[since Test 1.1] </code><span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> <p>A macro with argument <i>x</i>.</p> -<p>This function was introduced in Test 1.1.</p> +<p>This macro was introduced in Test 1.1.</p> <!-- @@@QDOCTEST_MACRO2 --> <!-- $$$Q_INVOKABLE[overload1]$$$Q_INVOKABLE --> <h3 class="fn" id="Q_INVOKABLE"><span class="name">Q_INVOKABLE</span></h3> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html index 503ec2560..eba2cab2a 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html @@ -122,7 +122,7 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr><tr><td class="me <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> <h3 class="fn" id="QDOCTEST_MACRO2"><code>[since Test 1.1] </code><span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> <p>A macro with argument <i>x</i>.</p> -<p>This function was introduced in Test 1.1.</p> +<p>This macro was introduced in Test 1.1.</p> <!-- @@@QDOCTEST_MACRO2 --> </div> </body> |