summaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorThibaut Cuvelier <cuvelier.thibaut@gmail.com>2022-07-24 18:13:51 +0200
committerPaul Wicking <paul.wicking@qt.io>2022-11-04 10:59:17 +0100
commit2c71bb2979220588d46337be6d5879bbb7012eaf (patch)
tree06121db9403b033a61664b850cbb93054fd83607 /tests
parent73ca58565f258d8d03554dcc17a0cae7b4679259 (diff)
downloadqttools-2c71bb2979220588d46337be6d5879bbb7012eaf.tar.gz
Output the parent node name in synopsis just before the node
This change ought to avoid cases like a section title is e.g. "QSqlQueryModel::void setQuery(const QSqlQuery &query)" i.e. with the class name before the return type (void). Implement it slightly more generally than strictly required with a name prefix. Change-Id: I5c49900b48196eb65e6fc98b5a09a2d4825203ec Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'tests')
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml30
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml4
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml10
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/scopedenum-docbook/testqdoc-test.xml34
4 files changed, 39 insertions, 39 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 41370f916..9c7e71aab 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml
@@ -62,8 +62,8 @@
<db:section xml:id="member-function-documentation">
<db:title>Member Function Documentation</db:title>
<db:section xml:id="overload">
-<db:title>[protected] Test::void overload()</db:title>
-<db:bridgehead renderas="sect2" xml:id="overload-1">[protected, since Test 1.2] Test::void overload(bool <db:emphasis>b</db:emphasis>)</db:bridgehead>
+<db:title>[protected] void Test::overload()</db:title>
+<db:bridgehead renderas="sect2" xml:id="overload-1">[protected, since Test 1.2] void Test::overload(bool <db:emphasis>b</db:emphasis>)</db:bridgehead>
<db:para>Overloads that share a documentation comment, optionally taking a parameter <db:code role="parameter">b</db:code>.</db:para>
</db:section>
<db:section xml:id="Test">
@@ -81,7 +81,7 @@
<db:para>Default constructor.</db:para>
</db:section>
<db:section xml:id="funcPtr">
-<db:title>Test::void (*)(bool) funcPtr(bool <db:emphasis>b</db:emphasis>, const char *<db:emphasis>s</db:emphasis>)</db:title>
+<db:title>void (*)(bool) Test::funcPtr(bool <db:emphasis>b</db:emphasis>, const char *<db:emphasis>s</db:emphasis>)</db:title>
<db:methodsynopsis>
<db:type>void (*)(bool)</db:type>
<db:methodname>funcPtr</db:methodname>
@@ -102,7 +102,7 @@
<db:para>Returns a pointer to a function that takes a boolean. Uses <db:code role="parameter">b</db:code> and <db:code role="parameter">s</db:code>.</db:para>
</db:section>
<db:section xml:id="inlineFunction">
-<db:title>Test::void inlineFunction()</db:title>
+<db:title>void Test::inlineFunction()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>inlineFunction</db:methodname>
@@ -116,7 +116,7 @@
<db:para>An inline function, documented using the \fn QDoc command.</db:para>
</db:section>
<db:section xml:id="methodWithEmDashInItsDocs">
-<db:title>Test::void methodWithEmDashInItsDocs()</db:title>
+<db:title>void Test::methodWithEmDashInItsDocs()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>methodWithEmDashInItsDocs</db:methodname>
@@ -141,7 +141,7 @@
</db:section>
</db:section>
<db:section xml:id="methodWithEnDashInItsDocs">
-<db:title>Test::void methodWithEnDashInItsDocs()</db:title>
+<db:title>void Test::methodWithEnDashInItsDocs()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>methodWithEnDashInItsDocs</db:methodname>
@@ -170,7 +170,7 @@
</db:section>
</db:section>
<db:section xml:id="someFunction">
-<db:title>Test::int someFunction(<db:emphasis>int</db:emphasis>, int <db:emphasis>v</db:emphasis> = 0)</db:title>
+<db:title>int Test::someFunction(<db:emphasis>int</db:emphasis>, int <db:emphasis>v</db:emphasis> = 0)</db:title>
<db:methodsynopsis>
<db:type>int</db:type>
<db:methodname>someFunction</db:methodname>
@@ -192,7 +192,7 @@
<db:para>Function that takes a parameter <db:code role="parameter">v</db:code>. Also returns the value of <db:code role="parameter">v</db:code>.</db:para>
</db:section>
<db:section xml:id="someFunctionDefaultArg">
-<db:title>Test::void someFunctionDefaultArg(int <db:emphasis>i</db:emphasis>, bool <db:emphasis>b</db:emphasis> = false)</db:title>
+<db:title>void Test::someFunctionDefaultArg(int <db:emphasis>i</db:emphasis>, bool <db:emphasis>b</db:emphasis> = false)</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>someFunctionDefaultArg</db:methodname>
@@ -214,7 +214,7 @@
<db:para>Function that takes a parameter <db:code role="parameter">i</db:code> and <db:code role="parameter">b</db:code>.</db:para>
</db:section>
<db:section xml:id="virtualFun">
-<db:title>[virtual] Test::void virtualFun()</db:title>
+<db:title>[virtual] void Test::virtualFun()</db:title>
<db:methodsynopsis>
<db:modifier>virtual</db:modifier>
<db:void/>
@@ -229,7 +229,7 @@
<db:para>Function that must be reimplemented.</db:para>
</db:section>
<db:section xml:id="operator-eq">
-<db:title>[default] Test::TestQDoc::Test &amp;operator=(TestQDoc::Test &amp;&amp;<db:emphasis>other</db:emphasis>)</db:title>
+<db:title>[default] TestQDoc::Test &amp;Test::operator=(TestQDoc::Test &amp;&amp;<db:emphasis>other</db:emphasis>)</db:title>
<db:methodsynopsis>
<db:type>TestQDoc::Test &amp;</db:type>
<db:methodname>operator=</db:methodname>
@@ -297,12 +297,12 @@
<db:section xml:id="obsolete-member-function-documentation">
<db:title>Obsolete Member Function Documentation</db:title>
<db:section xml:id="operator-2b-2b">
-<db:title>Test::TestQDoc::Test &amp;operator++()</db:title>
-<db:bridgehead renderas="sect2" xml:id="operator--">Test::TestQDoc::Test &amp;operator--()</db:bridgehead>
+<db:title>TestQDoc::Test &amp;Test::operator++()</db:title>
+<db:bridgehead renderas="sect2" xml:id="operator--">TestQDoc::Test &amp;Test::operator--()</db:bridgehead>
<db:para>This function is deprecated. We strongly advise against using it in new code.</db:para>
</db:section>
<db:section xml:id="anotherObsoleteMember">
-<db:title>Test::void anotherObsoleteMember()</db:title>
+<db:title>void Test::anotherObsoleteMember()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>anotherObsoleteMember</db:methodname>
@@ -317,7 +317,7 @@
<db:para>Use <db:link xlink:href="testqdoc-test.xml#obsoleteMember">obsoleteMember</db:link>() instead.</db:para>
</db:section>
<db:section xml:id="deprecatedMember">
-<db:title>Test::void deprecatedMember()</db:title>
+<db:title>void Test::deprecatedMember()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>deprecatedMember</db:methodname>
@@ -332,7 +332,7 @@
<db:para>Use <db:link xlink:href="testqdoc-test.xml#someFunction">someFunction</db:link>() instead.</db:para>
</db:section>
<db:section xml:id="obsoleteMember">
-<db:title>Test::void obsoleteMember()</db:title>
+<db:title>void Test::obsoleteMember()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>obsoleteMember</db:methodname>
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 2a6d13375..5b792c60d 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml
@@ -72,7 +72,7 @@
<db:section xml:id="member-function-documentation">
<db:title>Member Function Documentation</db:title>
<db:section xml:id="virtualFun">
-<db:title>[override virtual] TestDerived::void virtualFun()</db:title>
+<db:title>[override virtual] void TestDerived::virtualFun()</db:title>
<db:methodsynopsis>
<db:modifier>virtual</db:modifier>
<db:void/>
@@ -94,7 +94,7 @@
<db:section xml:id="obsolete-member-function-documentation">
<db:title>Obsolete Member Function Documentation</db:title>
<db:section xml:id="staticObsoleteMember">
-<db:title>[static] TestDerived::void staticObsoleteMember()</db:title>
+<db:title>[static] void TestDerived::staticObsoleteMember()</db:title>
<db:methodsynopsis>
<db:modifier>static</db:modifier>
<db:void/>
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml b/tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml
index a6a9a5b25..d1532260c 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml
@@ -201,7 +201,7 @@
<db:section xml:id="member-function-documentation">
<db:title>Member Function Documentation</db:title>
<db:section xml:id="emitSomething">
-<db:title>[private signal] TestDerived::void emitSomething()</db:title>
+<db:title>[private signal] void TestDerived::emitSomething()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>emitSomething</db:methodname>
@@ -217,7 +217,7 @@
<db:para>This is a private signal. It can be used in signal connections but cannot be emitted by the user.</db:para></db:note>
</db:section>
<db:section xml:id="id">
-<db:title>[override virtual] TestDerived::int id()</db:title>
+<db:title>[override virtual] int TestDerived::id()</db:title>
<db:methodsynopsis>
<db:modifier>virtual</db:modifier>
<db:type>int</db:type>
@@ -233,7 +233,7 @@
<db:para>Reimplements an access function for property: <db:link xlink:href="testqdoc-test.xml#id-prop" role="property">Test::id</db:link>.</db:para>
</db:section>
<db:section xml:id="invokeMe">
-<db:title>[invokable] TestDerived::void invokeMe() const</db:title>
+<db:title>[invokable] void TestDerived::invokeMe() const</db:title>
<db:methodsynopsis>
<db:modifier>const</db:modifier>
<db:void/>
@@ -251,7 +251,7 @@
</db:note>
</db:section>
<db:section xml:id="virtualFun">
-<db:title>[override virtual] TestDerived::void virtualFun()</db:title>
+<db:title>[override virtual] void TestDerived::virtualFun()</db:title>
<db:methodsynopsis>
<db:modifier>virtual</db:modifier>
<db:void/>
@@ -273,7 +273,7 @@
<db:section xml:id="obsolete-member-function-documentation">
<db:title>Obsolete Member Function Documentation</db:title>
<db:section xml:id="staticObsoleteMember">
-<db:title>[static] TestDerived::void staticObsoleteMember()</db:title>
+<db:title>[static] void TestDerived::staticObsoleteMember()</db:title>
<db:methodsynopsis>
<db:modifier>static</db:modifier>
<db:void/>
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 e35188636..16caf5a24 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
@@ -49,7 +49,7 @@
<db:section xml:id="member-type-documentation">
<db:title>Member Type Documentation</db:title>
<db:section xml:id="ClassicEnum-enum">
-<db:title>Test::enum ClassicEnum</db:title>
+<db:title>enum Test::ClassicEnum</db:title>
<db:enumsynopsis>
<db:enumname>ClassicEnum</db:enumname>
<db:enumitem>
@@ -106,7 +106,7 @@
</db:informaltable>
</db:section>
<db:section xml:id="ScopedEnum-enum">
-<db:title>Test::enum ScopedEnum</db:title>
+<db:title>enum Test::ScopedEnum</db:title>
<db:enumsynopsis>
<db:enumname>ScopedEnum</db:enumname>
<db:enumitem>
@@ -189,8 +189,8 @@
<db:section xml:id="member-function-documentation">
<db:title>Member Function Documentation</db:title>
<db:section xml:id="overload">
-<db:title>[protected] Test::void overload()</db:title>
-<db:bridgehead renderas="sect2" xml:id="overload-1">[protected, since Test 1.2] Test::void overload(bool <db:emphasis>b</db:emphasis>)</db:bridgehead>
+<db:title>[protected] void Test::overload()</db:title>
+<db:bridgehead renderas="sect2" xml:id="overload-1">[protected, since Test 1.2] void Test::overload(bool <db:emphasis>b</db:emphasis>)</db:bridgehead>
<db:para>Overloads that share a documentation comment, optionally taking a parameter <db:code role="parameter">b</db:code>.</db:para>
</db:section>
<db:section xml:id="Test">
@@ -208,7 +208,7 @@
<db:para>Default constructor.</db:para>
</db:section>
<db:section xml:id="funcPtr">
-<db:title>Test::void (*)(bool) funcPtr(bool <db:emphasis>b</db:emphasis>, const char *<db:emphasis>s</db:emphasis>)</db:title>
+<db:title>void (*)(bool) Test::funcPtr(bool <db:emphasis>b</db:emphasis>, const char *<db:emphasis>s</db:emphasis>)</db:title>
<db:methodsynopsis>
<db:type>void (*)(bool)</db:type>
<db:methodname>funcPtr</db:methodname>
@@ -229,7 +229,7 @@
<db:para>Returns a pointer to a function that takes a boolean. Uses <db:code role="parameter">b</db:code> and <db:code role="parameter">s</db:code>.</db:para>
</db:section>
<db:section xml:id="inlineFunction">
-<db:title>Test::void inlineFunction()</db:title>
+<db:title>void Test::inlineFunction()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>inlineFunction</db:methodname>
@@ -243,7 +243,7 @@
<db:para>An inline function, documented using the \fn QDoc command.</db:para>
</db:section>
<db:section xml:id="methodWithEmDashInItsDocs">
-<db:title>Test::void methodWithEmDashInItsDocs()</db:title>
+<db:title>void Test::methodWithEmDashInItsDocs()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>methodWithEmDashInItsDocs</db:methodname>
@@ -268,7 +268,7 @@
</db:section>
</db:section>
<db:section xml:id="methodWithEnDashInItsDocs">
-<db:title>Test::void methodWithEnDashInItsDocs()</db:title>
+<db:title>void Test::methodWithEnDashInItsDocs()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>methodWithEnDashInItsDocs</db:methodname>
@@ -297,7 +297,7 @@
</db:section>
</db:section>
<db:section xml:id="someFunction">
-<db:title>Test::int someFunction(<db:emphasis>int</db:emphasis>, int <db:emphasis>v</db:emphasis> = 0)</db:title>
+<db:title>int Test::someFunction(<db:emphasis>int</db:emphasis>, int <db:emphasis>v</db:emphasis> = 0)</db:title>
<db:methodsynopsis>
<db:type>int</db:type>
<db:methodname>someFunction</db:methodname>
@@ -319,7 +319,7 @@
<db:para>Function that takes a parameter <db:code role="parameter">v</db:code>. Also returns the value of <db:code role="parameter">v</db:code>.</db:para>
</db:section>
<db:section xml:id="someFunctionDefaultArg">
-<db:title>Test::void someFunctionDefaultArg(int <db:emphasis>i</db:emphasis>, bool <db:emphasis>b</db:emphasis> = false)</db:title>
+<db:title>void Test::someFunctionDefaultArg(int <db:emphasis>i</db:emphasis>, bool <db:emphasis>b</db:emphasis> = false)</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>someFunctionDefaultArg</db:methodname>
@@ -341,7 +341,7 @@
<db:para>Function that takes a parameter <db:code role="parameter">i</db:code> and <db:code role="parameter">b</db:code>.</db:para>
</db:section>
<db:section xml:id="virtualFun">
-<db:title>[virtual] Test::void virtualFun()</db:title>
+<db:title>[virtual] void Test::virtualFun()</db:title>
<db:methodsynopsis>
<db:modifier>virtual</db:modifier>
<db:void/>
@@ -356,7 +356,7 @@
<db:para>Function that must be reimplemented.</db:para>
</db:section>
<db:section xml:id="operator-eq">
-<db:title>[default] Test::TestQDoc::Test &amp;operator=(TestQDoc::Test &amp;&amp;<db:emphasis>other</db:emphasis>)</db:title>
+<db:title>[default] TestQDoc::Test &amp;Test::operator=(TestQDoc::Test &amp;&amp;<db:emphasis>other</db:emphasis>)</db:title>
<db:methodsynopsis>
<db:type>TestQDoc::Test &amp;</db:type>
<db:methodname>operator=</db:methodname>
@@ -424,12 +424,12 @@
<db:section xml:id="obsolete-member-function-documentation">
<db:title>Obsolete Member Function Documentation</db:title>
<db:section xml:id="operator-2b-2b">
-<db:title>Test::TestQDoc::Test &amp;operator++()</db:title>
-<db:bridgehead renderas="sect2" xml:id="operator--">Test::TestQDoc::Test &amp;operator--()</db:bridgehead>
+<db:title>TestQDoc::Test &amp;Test::operator++()</db:title>
+<db:bridgehead renderas="sect2" xml:id="operator--">TestQDoc::Test &amp;Test::operator--()</db:bridgehead>
<db:para>This function is deprecated. We strongly advise against using it in new code.</db:para>
</db:section>
<db:section xml:id="anotherObsoleteMember">
-<db:title>Test::void anotherObsoleteMember()</db:title>
+<db:title>void Test::anotherObsoleteMember()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>anotherObsoleteMember</db:methodname>
@@ -444,7 +444,7 @@
<db:para>Use <db:link xlink:href="testqdoc-test.xml#obsoleteMember">obsoleteMember</db:link>() instead.</db:para>
</db:section>
<db:section xml:id="deprecatedMember">
-<db:title>Test::void deprecatedMember()</db:title>
+<db:title>void Test::deprecatedMember()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>deprecatedMember</db:methodname>
@@ -459,7 +459,7 @@
<db:para>Use <db:link xlink:href="testqdoc-test.xml#someFunction">someFunction</db:link>() instead.</db:para>
</db:section>
<db:section xml:id="obsoleteMember">
-<db:title>Test::void obsoleteMember()</db:title>
+<db:title>void Test::obsoleteMember()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>obsoleteMember</db:methodname>