diff options
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/expected_output/docbook')
11 files changed, 2 insertions, 442 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-abstractparent.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-abstractparent.xml index 154b70b0f..1691fbadf 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-abstractparent.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-abstractparent.xml @@ -36,28 +36,10 @@ <db:title>Property Documentation</db:title> <db:section xml:id="children-prop"> <db:title>[default] children : list<Child></db:title> -<db:fieldsynopsis> -<db:type>list<Child></db:type> -<db:varname>children</db:varname> -<db:modifier>writable</db:modifier> -<db:modifier>[default]</db:modifier> - -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Children of the type.</db:para> </db:section> <db:section xml:id="name-prop"> <db:title>name : string</db:title> -<db:fieldsynopsis> -<db:type>string</db:type> -<db:varname>name</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Name of this parent.</db:para> </db:section> </db:section> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-child.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-child.xml index 76df460b7..e3a347678 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-child.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-child.xml @@ -36,28 +36,10 @@ <db:title>Property Documentation</db:title> <db:section xml:id="children-prop"> <db:title>[default] children : list<Child></db:title> -<db:fieldsynopsis> -<db:type>list<Child></db:type> -<db:varname>children</db:varname> -<db:modifier>writable</db:modifier> -<db:modifier>[default]</db:modifier> - -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Children of the type.</db:para> </db:section> <db:section xml:id="name-prop"> <db:title>name : string</db:title> -<db:fieldsynopsis> -<db:type>string</db:type> -<db:varname>name</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Name of this child.</db:para> </db:section> </db:section> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-doctest.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-doctest.xml index d39a330bb..5091e0e27 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-doctest.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-doctest.xml @@ -34,14 +34,6 @@ <db:title>Property Documentation</db:title> <db:section xml:id="active-prop"> <db:title>[default: true] active : bool</db:title> -<db:fieldsynopsis> -<db:type>bool</db:type> -<db:varname>active</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Whether the test is active.</db:para> <db:section> <db:title>See Also</db:title> @@ -54,15 +46,6 @@ </db:section> <db:section xml:id="name-prop"> <db:title>[required] name : string</db:title> -<db:fieldsynopsis> -<db:type>string</db:type> -<db:varname>name</db:varname> -<db:modifier>writable</db:modifier> -<db:modifier>required</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Name of the test.</db:para> <db:programlisting language="qml">DocTest { name: &quot;test&quot; diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml index 4422b6962..4f846dfac 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-type.xml @@ -42,79 +42,21 @@ <db:title>Property Documentation</db:title> <db:section xml:id="fifth-prop"> <db:title>fifth : int</db:title> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>fifth</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> -<db:bridgehead renderas="sect2">fourth : int</db:bridgehead><db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>fourth</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> -<db:para>A group of properties sharing a documentation comment.</db:para> +<db:bridgehead renderas="sect2">fourth : int</db:bridgehead><db:para>A group of properties sharing a documentation comment.</db:para> </db:section> <db:section xml:id="group-prop"> <db:title>group group</db:title> <db:bridgehead renderas="sect2" xml:id="group.first-prop">group.first : int</db:bridgehead> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>group.first</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:bridgehead renderas="sect2" xml:id="group.second-prop">group.second : int</db:bridgehead> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>group.second</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:bridgehead renderas="sect2" xml:id="group.third-prop">group.third : int</db:bridgehead> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>group.third</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>A property group.</db:para> </db:section> <db:section xml:id="id-prop"> <db:title>[read-only] id : int</db:title> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>id</db:varname> -<db:modifier>[read-only]</db:modifier> - -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>A read-only property.</db:para> </db:section> <db:section xml:id="name-prop"> <db:title>[required] name : string</db:title> -<db:fieldsynopsis> -<db:type>string</db:type> -<db:varname>name</db:varname> -<db:modifier>writable</db:modifier> -<db:modifier>required</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Name of the Test.</db:para> </db:section> </db:section> @@ -122,15 +64,6 @@ <db:title>Attached Property Documentation</db:title> <db:section xml:id="type-attached-prop"> <db:title>[default: Type.NoType] Type.type : enumeration</db:title> -<db:fieldsynopsis> -<db:type>enumeration</db:type> -<db:varname>Type.type</db:varname> -<db:modifier>attached</db:modifier> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:informaltable> <db:thead> <db:tr> @@ -188,27 +121,7 @@ <db:title>Method Documentation</db:title> <db:section xml:id="disable-method"> <db:title>disable()</db:title> -<db:methodsynopsis> -<db:type></db:type> -<db:methodname>disable</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">qmlmethod</db:synopsisinfo> -<db:synopsisinfo role="signature">disable()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> -<db:bridgehead renderas="sect2">enable()</db:bridgehead><db:methodsynopsis> -<db:type></db:type> -<db:methodname>enable</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">qmlmethod</db:synopsisinfo> -<db:synopsisinfo role="signature">enable()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> -<db:para>Enables or disables this type.</db:para> +<db:bridgehead renderas="sect2">enable()</db:bridgehead><db:para>Enables or disables this type.</db:para> </db:section> <db:section xml:id="copy-method"> <db:title>Type copy(<db:emphasis>a</db:emphasis>)</db:title> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-yetanotherchild.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-yetanotherchild.xml index 34264b735..492e1b64e 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-yetanotherchild.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-qdoc-test-yetanotherchild.xml @@ -30,14 +30,6 @@ <db:title>Property Documentation</db:title> <db:section xml:id="prop-prop"> <db:title>prop : int</db:title> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>prop</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Propagated to inheriting type docs.</db:para> </db:section> </db:section> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-progressbar.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-progressbar.xml index cd0945ec1..ac48b6471 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-progressbar.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-progressbar.xml @@ -26,14 +26,6 @@ <db:title>Property Documentation</db:title> <db:section xml:id="color-prop"> <db:title>color : color</db:title> -<db:fieldsynopsis> -<db:type>color</db:type> -<db:varname>color</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>The color of the <db:link xlink:href="qml-uicomponents-progressbar.xml">ProgressBar</db:link>'s gradient. Must bind to a color type.</db:para> <db:section> <db:title>See Also</db:title> @@ -46,38 +38,14 @@ </db:section> <db:section xml:id="maximum-prop"> <db:title>maximum : int</db:title> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>maximum</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>The maximum value of the <db:link xlink:href="qml-uicomponents-progressbar.xml">ProgressBar</db:link> range. The <db:link xlink:href="qml-uicomponents-progressbar.xml#value-prop">value</db:link> must not be more than this value.</db:para> </db:section> <db:section xml:id="minimum-prop"> <db:title>minimum : int</db:title> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>minimum</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>The minimum value of the <db:link xlink:href="qml-uicomponents-progressbar.xml">ProgressBar</db:link> range. The <db:link xlink:href="qml-uicomponents-progressbar.xml#value-prop">value</db:link> must not be less than this value.</db:para> </db:section> <db:section xml:id="secondColor-prop"> <db:title>secondColor : color</db:title> -<db:fieldsynopsis> -<db:type>color</db:type> -<db:varname>secondColor</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>The second color of the <db:link xlink:href="qml-uicomponents-progressbar.xml">ProgressBar</db:link>'s gradient. Must bind to a color type.</db:para> <db:section> <db:title>See Also</db:title> @@ -90,14 +58,6 @@ </db:section> <db:section xml:id="value-prop"> <db:title>value : int</db:title> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>value</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>The value of the progress.</db:para> </db:section> </db:section> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-switch.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-switch.xml index 65992be73..6c9d4a0f6 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-switch.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-switch.xml @@ -26,14 +26,6 @@ <db:title>Property Documentation</db:title> <db:section xml:id="on-prop"> <db:title>on : bool</db:title> -<db:fieldsynopsis> -<db:type>bool</db:type> -<db:varname>on</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>Indicates the state of the switch. If <db:code>false</db:code>, then the switch is in the <db:code>off</db:code> state.</db:para> </db:section> </db:section> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-tabwidget.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-tabwidget.xml index 61644e64d..e051ba196 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-tabwidget.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qml-uicomponents-tabwidget.xml @@ -46,27 +46,10 @@ <db:title>Property Documentation</db:title> <db:section xml:id="current-prop"> <db:title>current : int</db:title> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>current</db:varname> -<db:modifier>writable</db:modifier> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>The currently active tab in the <db:link xlink:href="qml-uicomponents-tabwidget.xml">TabWidget</db:link>.</db:para> </db:section> <db:section xml:id="sampleReadOnlyProperty-prop"> <db:title>[read-only] sampleReadOnlyProperty : int</db:title> -<db:fieldsynopsis> -<db:type>int</db:type> -<db:varname>sampleReadOnlyProperty</db:varname> -<db:modifier>[read-only]</db:modifier> - -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:fieldsynopsis> <db:para>A sample <db:code>read-only</db:code> property. A contrived property to demonstrate QDoc's ability to detect read-only properties.</db:para> <db:para>The signature is:</db:para> <db:programlisting language="cpp">readonly property int sampleReadOnlyProperty: 0 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 06b8f5816..12b574d2a 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml @@ -57,12 +57,6 @@ <db:title>Member Type Documentation</db:title> <db:section xml:id="SomeType-typedef"> <db:title>Test::SomeType</db:title> -<db:typedefsynopsis> -<db:typedefname>SomeType</db:typedefname> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:typedefsynopsis> <db:para>A typedef.</db:para> </db:section> </db:section> @@ -75,65 +69,18 @@ </db:section> <db:section xml:id="Test"> <db:title>[noexcept default] Test::Test()</db:title> -<db:constructorsynopsis> -<db:methodname>Test</db:methodname> -<db:void/> -<db:modifier>default</db:modifier> -<db:synopsisinfo role="meta">constructor</db:synopsisinfo> -<db:synopsisinfo role="signature">Test() = default</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:constructorsynopsis> <db:para>Default constructor.</db:para> </db:section> <db:section xml:id="funcPtr"> <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> -<db:methodparam> -<db:type>bool</db:type> -<db:parameter>b</db:parameter> -</db:methodparam> -<db:methodparam> -<db:type>const char *</db:type> -<db:parameter>s</db:parameter> -</db:methodparam> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void (*)(bool) funcPtr(bool b, const char *s)</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <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>void Test::inlineFunction()</db:title> -<db:methodsynopsis> -<db:void/> -<db:methodname>inlineFunction</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void inlineFunction()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>An inline function, documented using the \fn QDoc command.</db:para> </db:section> <db:section xml:id="methodWithEmDashInItsDocs"> <db:title>void Test::methodWithEmDashInItsDocs()</db:title> -<db:methodsynopsis> -<db:void/> -<db:methodname>methodWithEmDashInItsDocs</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void methodWithEmDashInItsDocs()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>This method has em dashes in its documentation—as you'll find represented by <db:code>---</db:code> in the sources—here and there. The important bit to note is that when passed e.g. to the \c command, the three hyphens are processed as input to the command and not replaced by an em dash.</db:para> <db:para>-----------------------------------------------------------------------</db:para> <db:para>People can still add a bunch of dashes, though, without QDoc replacing them all with a series of em dashes.</db:para> @@ -149,16 +96,6 @@ </db:section> <db:section xml:id="methodWithEnDashInItsDocs"> <db:title>void Test::methodWithEnDashInItsDocs()</db:title> -<db:methodsynopsis> -<db:void/> -<db:methodname>methodWithEnDashInItsDocs</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void methodWithEnDashInItsDocs()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>This method has en dashes in its documentation – as you'll find represented by <db:code>--</db:code> in the sources – here and there. The important bit to note is that when passed e.g. to the \c command, the two hyphens are processed as input to the command and not replaced by an en dash. This also applies to code blocks, where otherwise, the decrement operator would get completely borked:</db:para> <db:programlisting language="cpp">for (int i = 42; i &gt; 0; --i) // Do something cool during countdown. @@ -178,79 +115,18 @@ </db:section> <db:section xml:id="someFunction"> <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> -<db:methodparam> -<db:type>int</db:type> -<db:parameter></db:parameter> -</db:methodparam> -<db:methodparam> -<db:type>int</db:type> -<db:parameter>v</db:parameter> -<db:initializer>0</db:initializer> -</db:methodparam> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">int someFunction(int, int v)</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <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>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> -<db:methodparam> -<db:type>int</db:type> -<db:parameter>i</db:parameter> -</db:methodparam> -<db:methodparam> -<db:type>bool</db:type> -<db:parameter>b</db:parameter> -<db:initializer>false</db:initializer> -</db:methodparam> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void someFunctionDefaultArg(int i, bool b)</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <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] void Test::virtualFun()</db:title> -<db:methodsynopsis> -<db:modifier>virtual</db:modifier> -<db:void/> -<db:methodname>virtualFun</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void virtualFun()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>Function that must be reimplemented.</db:para> </db:section> <db:section xml:id="operator-eq"> <db:title>[noexcept default] TestQDoc::Test &Test::operator=(TestQDoc::Test &&<db:emphasis>other</db:emphasis>)</db:title> -<db:methodsynopsis> -<db:type>TestQDoc::Test &</db:type> -<db:methodname>operator=</db:methodname> -<db:methodparam> -<db:type>TestQDoc::Test &&</db:type> -<db:parameter>other</db:parameter> -</db:methodparam> -<db:modifier>default</db:modifier> -<db:synopsisinfo role="meta">move-assign</db:synopsisinfo> -<db:synopsisinfo role="signature">TestQDoc::Test & operator=(TestQDoc::Test &&other) = default</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>Move-assigns <db:code role="parameter">other</db:code>.</db:para> </db:section> </db:section> @@ -258,23 +134,6 @@ <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 role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</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> @@ -282,18 +141,6 @@ <db:title>Macro Documentation</db:title> <db:section xml:id="QDOCTEST_MACRO2"> <db:title>[since Test 1.1] QDOCTEST_MACRO2(int &<db:emphasis>x</db:emphasis>)</db:title> -<db:methodsynopsis> -<db:methodname>QDOCTEST_MACRO2</db:methodname> -<db:methodparam> -<db:type>int &</db:type> -<db:parameter>x</db:parameter> -</db:methodparam> -<db:synopsisinfo role="meta">macrowithparams</db:synopsisinfo> -<db:synopsisinfo role="signature">QDOCTEST_MACRO2(int &x)</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo 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 macro was introduced in Test 1.1.</db:para> </db:section> @@ -310,46 +157,16 @@ </db:section> <db:section xml:id="anotherObsoleteMember"> <db:title>void Test::anotherObsoleteMember()</db:title> -<db:methodsynopsis> -<db:void/> -<db:methodname>anotherObsoleteMember</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void anotherObsoleteMember()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">deprecated</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>This function is deprecated. We strongly advise against using it in new code.</db:para> <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>void Test::deprecatedMember()</db:title> -<db:methodsynopsis> -<db:void/> -<db:methodname>deprecatedMember</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void deprecatedMember()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">deprecated</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>This function is deprecated since 6.0. We strongly advise against using it in new code.</db:para> <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>void Test::obsoleteMember()</db:title> -<db:methodsynopsis> -<db:void/> -<db:methodname>obsoleteMember</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void obsoleteMember()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">deprecated</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>This function is deprecated. We strongly advise against using it in new code.</db:para> <db:para>Use <db:link xlink:href="testqdoc-test.xml#someFunction">someFunction</db:link>() instead.</db:para> </db:section> 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 5b792c60d..e28f7f70d 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-testderived.xml @@ -50,22 +50,10 @@ <db:title>Member Type Documentation</db:title> <db:section xml:id="DerivedType-typedef"> <db:title>[alias] TestDerived::DerivedType</db:title> -<db:typedefsynopsis> -<db:typedefname>DerivedType</db:typedefname> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:typedefsynopsis> <db:para>An aliased typedef.</db:para> </db:section> <db:section xml:id="NotTypedef-typedef"> <db:title>[alias] TestDerived::NotTypedef</db:title> -<db:typedefsynopsis> -<db:typedefname>NotTypedef</db:typedefname> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:typedefsynopsis> <db:para>I'm an alias, not a typedef.</db:para> </db:section> </db:section> @@ -73,18 +61,6 @@ <db:title>Member Function Documentation</db:title> <db:section xml:id="virtualFun"> <db:title>[override virtual] void TestDerived::virtualFun()</db:title> -<db:methodsynopsis> -<db:modifier>virtual</db:modifier> -<db:void/> -<db:methodname>virtualFun</db:methodname> -<db:void/> -<db:modifier>override</db:modifier> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void virtualFun() override</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>Reimplements: <db:link xlink:href="testqdoc-test.xml#virtualFun" role="function">Test::virtualFun()</db:link>.</db:para> </db:section> </db:section> @@ -95,17 +71,6 @@ <db:title>Obsolete Member Function Documentation</db:title> <db:section xml:id="staticObsoleteMember"> <db:title>[static] void TestDerived::staticObsoleteMember()</db:title> -<db:methodsynopsis> -<db:modifier>static</db:modifier> -<db:void/> -<db:methodname>staticObsoleteMember</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">plain</db:synopsisinfo> -<db:synopsisinfo role="signature">void staticObsoleteMember()</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">deprecated</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> <db:para>This function is deprecated. We strongly advise against using it in new code.</db:para> <db:para>Static obsolete method.</db:para> </db:section> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc.xml index 7fd926ed1..a00553748 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc.xml @@ -58,15 +58,6 @@ <db:title>Macro Documentation</db:title> <db:section xml:id="QDOCTEST_MACRO"> <db:title>QDOCTEST_MACRO</db:title> -<db:methodsynopsis> -<db:methodname>QDOCTEST_MACRO</db:methodname> -<db:void/> -<db:synopsisinfo role="meta">macrowithoutparams</db:synopsisinfo> -<db:synopsisinfo role="signature">QDOCTEST_MACRO</db:synopsisinfo> -<db:synopsisinfo role="access">public</db:synopsisinfo> -<db:synopsisinfo role="status">active</db:synopsisinfo> -<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> -</db:methodsynopsis> </db:section> </db:section> </db:article> |