diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-09-29 18:25:18 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-10-08 12:14:29 +0200 |
| commit | 05ffeba75e90e226cd6ddf7d72cb9b9d0ad5f172 (patch) | |
| tree | 0530a002323f5112343ba5fee171b799c8fafc85 /tests | |
| parent | c3b26e9a55ae39f2c88a343990bd691351e9efd4 (diff) | |
qdoc: Document friend functions as related non-members
When parsing a friend declaration in a class, QDoc associated the
subsequent function declarations to the namespace scope. This
was conceptually correct as friend functions are not class members,
but made it impossible to match documentation to these functions using
the \fn command; the functions are still found under the class scope
in Clang AST, and this has to align with QDoc's node tree for the
documentation to be matched correctly.
Fix this by letting friend functions remain in the class, keeping
track of the friend declarations, and marking friend functions
automatically as related non-members.
Fixes: QTBUG-86987
Change-Id: I0ad26eed1c72af9302c9e420f5db0ec98c40d86a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tests')
14 files changed, 134 insertions, 0 deletions
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 b562b96f5..8e185d26c 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml @@ -155,6 +155,31 @@ <db:para>Function that must be reimplemented.</db:para> </db:section> </db:section> +<db:section xml:id="related-non-members"> +<db:title>Related Non-Members</db:title> +<db:section xml:id="operator-eq-eq"> +<db:title>bool operator==(const TestQDoc::Test &<db:emphasis>lhs</db:emphasis>, const TestQDoc::Test &<db:emphasis>rhs</db:emphasis>)</db:title> +<db:methodsynopsis> +<db:type>bool</db:type> +<db:methodname>operator==</db:methodname> +<db:methodparam> +<db:type>const TestQDoc::Test &</db:type> +<db:parameter>lhs</db:parameter> +</db:methodparam> +<db:methodparam> +<db:type>const TestQDoc::Test &</db:type> +<db:parameter>rhs</db:parameter> +</db:methodparam> +<db:synopsisinfo db:role="meta">plain</db:synopsisinfo> +<db:synopsisinfo db:role="signature">bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)</db:synopsisinfo> +<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:methodsynopsis> +<db:para>Returns true if <db:code role="parameter">lhs</db:code> and <db:code role="parameter">rhs</db:code> are equal.</db:para> +</db:section> +</db:section> <db:section xml:id="macro-documentation"> <db:title>Macro Documentation</db:title> <db:section xml:id="QDOCTEST_MACRO2"> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp b/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp index 58738393a..57bea1d0e 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp +++ b/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp @@ -35,6 +35,7 @@ <keyword name="funcPtr" id="Test::funcPtr" ref="testqdoc-test.html#funcPtr"/> <keyword name="inlineFunction" id="Test::inlineFunction" ref="testqdoc-test.html#inlineFunction"/> <keyword name="obsoleteMember" id="Test::obsoleteMember" ref="testqdoc-test-obsolete.html#obsoleteMember"/> + <keyword name="operator==" id="operator==" ref="testqdoc-test.html#operator-eq-eq"/> <keyword name="overload" id="Test::overload" ref="testqdoc-test.html#overload"/> <keyword name="someFunction" id="Test::someFunction" ref="testqdoc-test.html#someFunction"/> <keyword name="someFunctionDefaultArg" id="Test::someFunctionDefaultArg" ref="testqdoc-test.html#someFunctionDefaultArg"/> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/html/testqdoc-test.webxml b/tests/auto/qdoc/generatedoutput/expected_output/html/testqdoc-test.webxml index f36904cad..943234154 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/html/testqdoc-test.webxml +++ b/tests/auto/qdoc/generatedoutput/expected_output/html/testqdoc-test.webxml @@ -42,6 +42,13 @@ <para>Use <link raw="someFunction()" href="testqdoc-test.html#someFunction" type="function">someFunction()</link> instead.</para> </description> </function> + <function name="operator==" href="testqdoc-test.html#operator-eq-eq" status="active" access="public" location="testcpp.h" documented="true" related="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="bool" signature="bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)"> + <parameter type="const TestQDoc::Test &" name="lhs" default=""/> + <parameter type="const TestQDoc::Test &" name="rhs" default=""/> + <description> + <para>Returns true if <argument>lhs</argument> and <argument>rhs</argument> are equal.</para> + </description> + </function> <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void overload()"> <description/> </function> 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 1b1d95eb6..262020fb1 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/ignoresince/testqdoc-test.html @@ -14,6 +14,7 @@ <li class="level1"><a href="#public-types">Public Types</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#protected-functions">Protected Functions</a></li> +<li class="level1"><a href="#related-non-members">Related Non-Members</a></li> <li class="level1"><a href="#macros">Macros</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> @@ -52,6 +53,11 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload">overload</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1">overload</a></b>(bool <i>b</i>)</td></tr> </table></div> +<a name="related-non-members"></a> +<h2 id="related-non-members">Related Non-Members</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq-eq">operator==</a></b>(const TestQDoc::Test &<i>lhs</i>, const TestQDoc::Test &<i>rhs</i>)</td></tr> +</table></div> <a name="macros"></a> <h2 id="macros">Macros</h2> <div class="table"><table class="alignedsummary"> @@ -100,6 +106,13 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <p>Function that must be reimplemented.</p> <!-- @@@virtualFun --> </div> +<div class="relnonmem"> +<h2>Related Non-Members</h2> +<!-- $$$operator==[overload1]$$$operator==constTestQDoc::Test&constTestQDoc::Test& --> +<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> +<p>Returns true if <i>lhs</i> and <i>rhs</i> are equal.</p> +<!-- @@@operator== --> +</div> <div class="macros"> <h2>Macro Documentation</h2> <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index b/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index index 471d00f3e..726534089 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index +++ b/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index @@ -25,6 +25,10 @@ </function> <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"/> <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="obsolete" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void obsoleteMember()"/> + <function name="operator==" href="testqdoc-test.html#operator-eq-eq" status="active" access="public" location="testcpp.h" documented="true" related="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="bool" signature="bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)"> + <parameter type="const TestQDoc::Test &" name="lhs" default=""/> + <parameter type="const TestQDoc::Test &" name="rhs" default=""/> + </function> <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void overload()"/> <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" documented="true" since="Test 1.2" meta="plain" virtual="non" const="false" static="false" final="false" override="false" overload="true" overload-number="1" type="void" signature="void overload(bool b)"> <parameter type="bool" name="b" default=""/> 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 9202c899a..7b1efb8e7 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 @@ -205,6 +205,31 @@ <db:para>Function that must be reimplemented.</db:para> </db:section> </db:section> +<db:section xml:id="related-non-members"> +<db:title>Related Non-Members</db:title> +<db:section xml:id="operator-eq-eq"> +<db:title>bool operator==(const TestQDoc::Test &<db:emphasis>lhs</db:emphasis>, const TestQDoc::Test &<db:emphasis>rhs</db:emphasis>)</db:title> +<db:methodsynopsis> +<db:type>bool</db:type> +<db:methodname>operator==</db:methodname> +<db:methodparam> +<db:type>const TestQDoc::Test &</db:type> +<db:parameter>lhs</db:parameter> +</db:methodparam> +<db:methodparam> +<db:type>const TestQDoc::Test &</db:type> +<db:parameter>rhs</db:parameter> +</db:methodparam> +<db:synopsisinfo db:role="meta">plain</db:synopsisinfo> +<db:synopsisinfo db:role="signature">bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)</db:synopsisinfo> +<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:methodsynopsis> +<db:para>Returns true if <db:code role="parameter">lhs</db:code> and <db:code role="parameter">rhs</db:code> are equal.</db:para> +</db:section> +</db:section> <db:section xml:id="macro-documentation"> <db:title>Macro Documentation</db:title> <db:section xml:id="QDOCTEST_MACRO2"> 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 0efc57730..1cf5c2d18 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/scopedenum/testqdoc-test.html @@ -14,6 +14,7 @@ <li class="level1"><a href="#public-types">Public Types</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#protected-functions">Protected Functions</a></li> +<li class="level1"><a href="#related-non-members">Related Non-Members</a></li> <li class="level1"><a href="#macros">Macros</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> @@ -53,6 +54,11 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload">overload</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1">overload</a></b>(bool <i>b</i>)</td></tr> </table></div> +<a name="related-non-members"></a> +<h2 id="related-non-members">Related Non-Members</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq-eq">operator==</a></b>(const TestQDoc::Test &<i>lhs</i>, const TestQDoc::Test &<i>rhs</i>)</td></tr> +</table></div> <a name="macros"></a> <h2 id="macros">Macros</h2> <div class="table"><table class="alignedsummary"> @@ -107,6 +113,13 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <p>Function that must be reimplemented.</p> <!-- @@@virtualFun --> </div> +<div class="relnonmem"> +<h2>Related Non-Members</h2> +<!-- $$$operator==[overload1]$$$operator==constTestQDoc::Test&constTestQDoc::Test& --> +<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> +<p>Returns true if <i>lhs</i> and <i>rhs</i> are equal.</p> +<!-- @@@operator== --> +</div> <div class="macros"> <h2>Macro Documentation</h2> <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> 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 5b7a34d8a..b1939c994 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/template/testqdoc-test.html @@ -14,6 +14,7 @@ <li class="level1"><a href="#public-types">Public Types</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#protected-functions">Protected Functions</a></li> +<li class="level1"><a href="#related-non-members">Related Non-Members</a></li> <li class="level1"><a href="#macros">Macros</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> @@ -55,6 +56,11 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload">overload</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1">overload</a></b>(bool <i>b</i>)</td></tr> </table></div> +<a name="related-non-members"></a> +<h2 id="related-non-members">Related Non-Members</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq-eq">operator==</a></b>(const TestQDoc::Test &<i>lhs</i>, const TestQDoc::Test &<i>rhs</i>)</td></tr> +</table></div> <a name="macros"></a> <h2 id="macros">Macros</h2> <div class="table"><table class="alignedsummary"> @@ -109,6 +115,13 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <p>Function that must be reimplemented.</p> <!-- @@@virtualFun --> </div> +<div class="relnonmem"> +<h2>Related Non-Members</h2> +<!-- $$$operator==[overload1]$$$operator==constTestQDoc::Test&constTestQDoc::Test& --> +<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> +<p>Returns true if <i>lhs</i> and <i>rhs</i> are equal.</p> +<!-- @@@operator== --> +</div> <div class="macros"> <h2>Macro Documentation</h2> <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/test.qhp b/tests/auto/qdoc/generatedoutput/expected_output/test.qhp index 9bcabb0ab..5745fdc64 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/test.qhp +++ b/tests/auto/qdoc/generatedoutput/expected_output/test.qhp @@ -111,6 +111,7 @@ <keyword name="name" id="Type::name" ref="qml-qdoc-test-type.html#name-prop"/> <keyword name="obsoleteMember" id="Test::obsoleteMember" ref="testqdoc-test-obsolete.html#obsoleteMember"/> <keyword name="on" id="Switch::on" ref="qml-uicomponents-switch.html#on-prop"/> + <keyword name="operator==" id="operator==" ref="testqdoc-test.html#operator-eq-eq"/> <keyword name="overload" id="Test::overload" ref="testqdoc-test.html#overload"/> <keyword name="rear" id="AbstractParent::rear" ref="qml-qdoc-test-abstractparent.html#rear-method"/> <keyword name="sampleReadOnlyProperty" id="TabWidget::sampleReadOnlyProperty" ref="qml-uicomponents-tabwidget.html#sampleReadOnlyProperty-prop"/> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index b/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index index 99df29222..fbe428f10 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index +++ b/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index @@ -24,6 +24,10 @@ </function> <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"/> <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="obsolete" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void obsoleteMember()"/> + <function name="operator==" href="testqdoc-test.html#operator-eq-eq" status="active" access="public" location="testcpp.h" documented="true" related="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="bool" signature="bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)"> + <parameter type="const TestQDoc::Test &" name="lhs" default=""/> + <parameter type="const TestQDoc::Test &" name="rhs" default=""/> + </function> <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void overload()"/> <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" documented="true" since="Test 1.2" meta="plain" virtual="non" const="false" static="false" final="false" override="false" overload="true" overload-number="1" type="void" signature="void overload(bool b)"> <parameter type="bool" name="b" default=""/> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html index 95ccc7c55..23627fc9d 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html @@ -14,6 +14,7 @@ <li class="level1"><a href="#public-types">Public Types</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#protected-functions">Protected Functions</a></li> +<li class="level1"><a href="#related-non-members">Related Non-Members</a></li> <li class="level1"><a href="#macros">Macros</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> @@ -52,6 +53,11 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload">overload</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1">overload</a></b>(bool <i>b</i>)</td></tr> </table></div> +<a name="related-non-members"></a> +<h2 id="related-non-members">Related Non-Members</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq-eq">operator==</a></b>(const TestQDoc::Test &<i>lhs</i>, const TestQDoc::Test &<i>rhs</i>)</td></tr> +</table></div> <a name="macros"></a> <h2 id="macros">Macros</h2> <div class="table"><table class="alignedsummary"> @@ -98,6 +104,13 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI <p>Function that must be reimplemented.</p> <!-- @@@virtualFun --> </div> +<div class="relnonmem"> +<h2>Related Non-Members</h2> +<!-- $$$operator==[overload1]$$$operator==constTestQDoc::Test&constTestQDoc::Test& --> +<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> +<p>Returns true if <i>lhs</i> and <i>rhs</i> are equal.</p> +<!-- @@@operator== --> +</div> <div class="macros"> <h2>Macro Documentation</h2> <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testtagfile.tags b/tests/auto/qdoc/generatedoutput/expected_output/testtagfile.tags index 893b6aba1..1a035c855 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testtagfile.tags +++ b/tests/auto/qdoc/generatedoutput/expected_output/testtagfile.tags @@ -165,6 +165,13 @@ <anchor>virtualFun</anchor> <arglist>()</arglist> </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>bool</type> + <name>operator==</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>operator-eq-eq</anchor> + <arglist>(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)</arglist> + </member> <member kind="function" protection="protected" virtualness="non" static="no"> <type>void</type> <name>overload</name> diff --git a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp index 13a17c2f8..247338076 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp +++ b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.cpp @@ -167,6 +167,12 @@ void Test::virtualFun() } /*! + \fn bool Test::operator==(const Test &lhs, const Test &rhs) + + Returns true if \a lhs and \a rhs are equal. +*/ + +/*! \typedef Test::SomeType \brief A typedef. */ diff --git a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.h b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.h index 684b5fff4..4b6d23a17 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.h +++ b/tests/auto/qdoc/generatedoutput/testdata/testcpp/testcpp.h @@ -71,6 +71,8 @@ using Specialized = Struct<int, T>; inline void inlineFunction() {}; virtual void virtualFun(); + friend bool operator==(const Test &lhs, const Test &rhs) { return false; } + protected: void overload() {} void overload(bool b) { if (!b) return; } |