diff options
| author | Thibaut Cuvelier <cuvelier.thibaut@gmail.com> | 2023-02-10 04:16:34 +0100 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2023-04-26 14:43:39 +0200 |
| commit | c6665d7ebf68cb3a1ed15527309eb70ffe927536 (patch) | |
| tree | 1cfef18cc6f16c0b01374e234c3f133486c64a77 | |
| parent | 07b966623856fc392bea477848e8be17bd8314ea (diff) | |
| download | qttools-c6665d7ebf68cb3a1ed15527309eb70ffe927536.tar.gz | |
QDoc DocBook: add new test suite for the extension tags
Explicitly test that the right tags are output when the DocBook 5.2
extensions are enabled. This test suite is made small intentionally,
because the extensions do not have an impact on that many pages.
Pick-to: 6.5
Change-Id: I6a135ddb20f17034287e0a6d5da4a5b96e064028
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
28 files changed, 1988 insertions, 3 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoc-test-qmlmodule.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoc-test-qmlmodule.xml new file mode 100644 index 000000000..cbdeb19b1 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoc-test-qmlmodule.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>QDoc.Test QML Module</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>QML Types for the Test module.</db:para> +<db:para><db:emphasis role="bold">This module is under development and is subject to change.</db:emphasis></db:para> +<db:para>This module was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:para><db:emphasis role="bold">This module is under development and is subject to change.</db:emphasis></db:para> +<db:para>This module was introduced in Qt 1.1.</db:para> +<db:anchor xml:id="details"/> +<db:variablelist role="members"> +<db:varlistentry> +<db:term><db:link xlink:href="qml-qdoc-test-doctest.xml" xlink:role="">DocTest</db:link></db:term> +<db:listitem> +<db:para>Represents a doc test case.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="qml-qdoc-test-abstractparent.xml" xlink:role="">AbstractParent</db:link></db:term> +<db:listitem> +<db:para>Abstract base QML type.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="qml-qdoc-test-child.xml" xlink:role="">Child</db:link></db:term> +<db:listitem> +<db:para>A Child inheriting its parent.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="qml-int.xml" xlink:role="">int</db:link></db:term> +<db:listitem> +<db:para>An integer value type.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="qml-qdoc-test-yetanotherchild.xml" xlink:role="">YetAnotherChild</db:link></db:term> +<db:listitem> +<db:para>A type inheriting from internal abstract parent.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="qml-qdoc-test-type.xml" xlink:role="">Type</db:link></db:term> +<db:listitem> +<db:para>A QML type documented in a .cpp file.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput-exhaustive.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput-exhaustive.xml new file mode 100644 index 000000000..878fb3211 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput-exhaustive.xml @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Exhaustive testing of QDoc commands</db:title> +<db:productname>OutputFromQDocFiles</db:productname> +<db:edition>OutputFromQDocFiles - A test project for QDoc build artifacts</db:edition> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>This page is a dumping ground for QDoc commands under test.</db:para> +</db:abstract> +</db:info> +<db:section xml:id="this-is-a-section1"> +<db:title>This is a section1</db:title> +<db:section xml:id="this-is-a-section2"> +<db:title>This is a section2</db:title> +<db:section xml:id="this-is-a-section3"> +<db:title>This is a section3</db:title> +<db:section xml:id="this-is-a-section4"> +<db:title>This is a section4</db:title> +<db:programlisting language="cpp" role="bad">This is bad code +</db:programlisting> +<db:para>This text should have a line break riiiiight noooow.</db:para> +<db:para><db:emphasis role="bold">All your text belong to bold</db:emphasis> ...And this is an examble of only <db:emphasis role="bold">bold</db:emphasis> being, well, bold.</db:para> +<db:programlisting language="cpp"> ... +</db:programlisting> +<db:title>This a caption</db:title> +<db:para>Lorem legal ipsum</db:para> +<db:blockquote><db:para>This is a quotation.</db:para> +</db:blockquote> +<db:programlisting role="raw-html"><![CDATA[<html><body>This is <b>raw</b>. Like the <h1>Eddie Murphy</h1> movie. Just not as funny.</body></html>]]></db:programlisting> +<db:sidebar><db:para>Look, ma! I made a sidebar!</db:para> +</db:sidebar> +<db:informaltable style="generic"> +<db:tr valign="top"> +<db:td> +<db:para>Table item in a table row</db:para> +</db:td> +</db:tr> +<db:tr valign="top"> +<db:td> +<db:para>Another item in a different row</db:para> +</db:td> +</db:tr> +</db:informaltable> +<db:important> +<db:para>This is really important.</db:para> +</db:important> +<db:note> +<db:para>The code above doesn't compile</db:para> +</db:note> +</db:section> +</db:section> +</db:section> +</db:section> +<db:section xml:id="images"> +<db:title>Images</db:title> +<db:para>An image without any text:</db:para> +<db:mediaobject> +<db:imageobject> +<db:imagedata fileref="images/leonardo-da-vinci.png"/> +</db:imageobject> +</db:mediaobject> +<db:para>An image with just an alternative text:</db:para> +<db:mediaobject> +<db:alt>Image alt</db:alt> +<db:imageobject> +<db:imagedata fileref="images/leonardo-da-vinci.png"/> +</db:imageobject> +</db:mediaobject> +<db:para>An image with alternative text and 1-atom caption:</db:para> +<db:figure> +<db:title>Image caption</db:title> +<db:mediaobject> +<db:alt>Image alt</db:alt> +<db:imageobject> +<db:imagedata fileref="images/leonardo-da-vinci.png"/> +</db:imageobject> +</db:mediaobject> +</db:figure> +<db:para>An image with alternative text and 2-atom caption:</db:para> +<db:figure> +<db:title>Image caption with <db:emphasis role="bold">bold</db:emphasis> text</db:title> +<db:mediaobject> +<db:alt>Image alt</db:alt> +<db:imageobject> +<db:imagedata fileref="images/leonardo-da-vinci.png"/> +</db:imageobject> +</db:mediaobject> +</db:figure> +<db:para>A bordered image:</db:para> +<db:mediaobject> +<db:imageobject> +<db:imagedata fileref="images/leonardo-da-vinci.png"/> +</db:imageobject> +</db:mediaobject> +<db:para>A bordered image with a caption:</db:para> +<db:figure> +<db:title>Screenshot of the System Tray Icon</db:title> +<db:mediaobject> +<db:imageobject> +<db:imagedata fileref="images/leonardo-da-vinci.png"/> +</db:imageobject> +</db:mediaobject> +</db:figure> +<db:para>An inline image:</db:para> +<db:para>The is a paragraph containing an <db:inlinemediaobject> +<db:imageobject> +<db:imagedata fileref="images/01.png"/> +</db:imageobject> +</db:inlinemediaobject> inline image to test if qdoc handles them properly, without considering rest of the line as alt text for the image.</db:para> +<db:para>An inline image with alt text:</db:para> +<db:para>Here is another example of <db:inlinemediaobject> +<db:alt>No. 1</db:alt> +<db:imageobject> +<db:imagedata fileref="images/01.png"/> +</db:imageobject> +</db:inlinemediaobject> inline image with alternative text, which should be added as an attribute to the inline image.</db:para> +</db:section> +<db:section xml:id="commands-not-yet-tested"> +<db:title>Commands not yet tested</db:title> +<db:warning> +<db:para>The following commands have yet to be tested: footnote link sincelist header index topicref // or just don’t care, remove it inlineimage printline printto printuntil // what’s the difference between printto and printuntil??? quotefile quotefromfile skipline skipto skipuntil span snippet codeline overload sub sup tableofcontents tt uicontrol endmapref endomit underline unicode</db:para> +</db:warning> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput-linking.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput-linking.xml new file mode 100644 index 000000000..51b7e62b3 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput-linking.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Testing QDoc's link command</db:title> +<db:productname>OutputFromQDocFiles</db:productname> +<db:edition>OutputFromQDocFiles - A test project for QDoc build artifacts</db:edition> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:extendedlink xlink:type="extended"><db:link xlink:to="qdoctests-qdocfileoutput.xml" xlink:type="arc" xlink:arcrole="prev" xlink:title="QDoc Testing"/></db:extendedlink> +<db:extendedlink xlink:type="extended"><db:link xlink:to="toc.xml" xlink:type="arc" xlink:arcrole="next" xlink:title="Table of Contents"/></db:extendedlink> +<db:abstract> +<db:para>This is a page for testing QDoc's link command.</db:para> +</db:abstract> +</db:info> +<db:anchor xml:id="link-test-target"/> +<db:section xml:id="link-targets"> +<db:title>Link targets</db:title> +<db:para>Valid parameters for the link command (<db:code>\l</db:code>) are page and section titles, targets defined with \target or \keyword commands, and API reference keywords (types, methods, namespaces, and so on).</db:para> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput.xml new file mode 100644 index 000000000..72905681d --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocfileoutput.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Testing QDoc output from .qdoc files</db:title> +<db:productname>OutputFromQDocFiles</db:productname> +<db:edition>OutputFromQDocFiles - A test project for QDoc build artifacts</db:edition> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:extendedlink xlink:type="extended"><db:link xlink:to="qdoctests-qdocfileoutput-linking.xml" xlink:type="arc" xlink:arcrole="next" xlink:title="QDoc Linking Test"/></db:extendedlink> +<db:abstract> +<db:para>This is a simple page for testing purposes only.</db:para> +</db:abstract> +</db:info> +<db:para>QDoc generates documentation for software projects. It does this by extracting <db:emphasis>QDoc comments</db:emphasis> from project source files. QDoc comments are signified by a C-style-like comment tag followed by an exclamation point, like this: <db:code>/*!</db:code> <db:code>This text is contained within QDoc comment tags.</db:code> <db:code>*/</db:code>.</db:para> +<db:section xml:id="supported-file-types"> +<db:title>Supported file types</db:title> +<db:para>QDoc parses <db:code>.cpp</db:code> and <db:code>.qdoc</db:code> files. It does extract comments from header (<db:code>.h</db:code>) files.</db:para> +</db:section> +<db:section xml:id="further-information"> +<db:title>Further information</db:title> +<db:para>This test document is written with the purpose of testing the output QDoc generates when parsing <db:code>.qdoc</db:code> files. It is fairly simple and makes use of a limited subset of QDoc's command. Those commands are:</db:para> +<db:itemizedlist> +<db:listitem> +<db:para><db:code>\page</db:code></db:para> +</db:listitem> +<db:listitem> +<db:para><db:code>\title</db:code></db:para> +</db:listitem> +<db:listitem> +<db:para><db:code>\brief</db:code></db:para> +</db:listitem> +<db:listitem> +<db:para><db:code>\e</db:code> (for emphasizing "QDoc comments")</db:para> +</db:listitem> +<db:listitem> +<db:para><db:code>\c</db:code> (for multiple monospace-formatted entries)</db:para> +</db:listitem> +<db:listitem> +<db:para><db:code>\section1</db:code></db:para> +</db:listitem> +<db:listitem> +<db:para><db:code>\list</db:code></db:para> +</db:listitem> +<db:listitem> +<db:para><db:code>\li</db:code></db:para> +</db:listitem> +<db:listitem> +<db:para><db:code>\endlist</db:code></db:para> +</db:listitem> +</db:itemizedlist> +</db:section> +<db:section xml:id="linking"> +<db:title>Linking</db:title> +<db:para>There are multiple ways to create hyperlinks to other topics:</db:para> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="qdoctests-qdocfileoutput-linking.xml">Linking to a page title</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="qdoctests-qdocfileoutput-linking.xml#link-targets">Linking to a section title</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="qdoctests-qdocfileoutput-linking.xml#link-test-target">Linking using a \target string</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="qdoctests-qdocfileoutput-linking.xml">Linking using a \keyword string</db:link></db:para> +</db:listitem> +</db:itemizedlist> +</db:section> +<db:section xml:id="qdoc-linking-test"> +<db:title>QDoc Linking Test</db:title> +<db:para>This section title is overridden by another target which takes precedence.</db:para> +</db:section> +<db:section xml:id="linking-to-something-in-a-section-title"> +<db:title>Linking to <db:link xlink:href="qdoctests-qdocfileoutput.xml#further-information">something</db:link> in a section title</db:title> +<db:para>This is allowed but a questionable practice.</db:para> +<db:note> +<db:para>You're looking at detailed information.</db:para> +</db:note> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocmanuallikefileoutput.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocmanuallikefileoutput.xml new file mode 100644 index 000000000..8372f150c --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qdoctests-qdocmanuallikefileoutput.xml @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Document Navigation</db:title> +<db:productname>OutputFromQDocFiles</db:productname> +<db:edition>OutputFromQDocFiles - A test project for QDoc build artifacts</db:edition> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A test project for QDoc build artifacts.</db:para></db:abstract> +</db:info> +<db:para>The navigation commands...</db:para> +<db:blockquote><db:programlisting role="raw-html"><![CDATA[ <table border="0" cellpadding="0" cellspacing="5" width="100%"> + + <tr> + <p> + [Previous: <a href="15-qdoc-commands-navigation.html#deadlink"> + Basic Qt</a>] + [<a href="15-qdoc-commands-navigation.html#deadlink">Contents</a>] + [Next: <a href="15-qdoc-commands-navigation.html#deadlink"> + Creating Dialogs</a>] + </p> + + <h1 align="center">Getting Started<br /></h1> + + <p> + This chapter shows how to combine basic C++ with the + functionality provided by Qt to create a few small graphical + interface (GUI) applications. + </p> + + <p> + [Previous: <a href="15-qdoc-commands-navigation.html#deadlink"> + Basic Qt</a>] + [<a href="15-qdoc-commands-navigation.html#deadlink">Contents</a>] + [Next: <a href="15-qdoc-commands-navigation.html#deadlink"> + Creating Dialogs</a>] + </p> + + </table> + ]]></db:programlisting> +</db:blockquote> +<db:programlisting language="cpp">&lt;head&gt; + ... + &lt;link rel=&quot;start&quot; href=&quot;basicqt.html&quot; /&gt; + ... +&lt;/head&gt; +</db:programlisting> +<db:section xml:id="commands"> +<db:title>Commands</db:title> +<db:anchor xml:id="previouspage-command"/> +<db:section xml:id="previouspage"> +<db:title>\previouspage</db:title> +<db:para>The \previouspage command...</db:para> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-int.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-int.xml new file mode 100644 index 000000000..c7ce09e55 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-int.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>int QML Value Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>An integer value type.</db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import QDoc.Test 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since:</db:term> +<db:listitem> +<db:para>Qt 1.1</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="method-documentation"> +<db:title>Method Documentation</db:title> +<db:section xml:id="abs-method"> +<db:title>int abs()</db:title> +<db:para>Returns the absolute value of this integer.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-abstractparent.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-abstractparent.xml new file mode 100644 index 000000000..154b70b0f --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-abstractparent.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>AbstractParent QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Abstract base QML type.</db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import QDoc.Test 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since:</db:term> +<db:listitem> +<db:para>Qt 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Inherited By:</db:term> +<db:listitem> +<db:para><db:link xlink:href="qml-qdoc-test-child.xml" xlink:role="">Child</db:link></db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="property-documentation"> +<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> +<db:section xml:id="method-documentation"> +<db:title>Method Documentation</db:title> +<db:section xml:id="name-method"> +<db:title>void name(Child <db:emphasis>child</db:emphasis>, <db:emphasis>name</db:emphasis>)</db:title> +<db:para>Name a <db:code role="parameter">child</db:code> using <db:code role="parameter">name</db:code>.</db:para> +</db:section> +<db:section xml:id="name-method-1"> +<db:title>void name()</db:title> +<db:para>Name all children with random names.</db:para> +</db:section> +<db:section xml:id="rear-method"> +<db:title>void rear(Child <db:emphasis>child</db:emphasis>, var <db:emphasis>method</db:emphasis> = Strict)</db:title> +<db:para>Do some abstract parenting on <db:code role="parameter">child</db:code> using a specific <db:code role="parameter">method</db:code>.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-child.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-child.xml new file mode 100644 index 000000000..76df460b7 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-child.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Child QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A Child inheriting its parent.</db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import QDoc.Test 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since:</db:term> +<db:listitem> +<db:para>Qt 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Inherits:</db:term> +<db:listitem> +<db:para><db:link xlink:href="">AbstractParent</db:link></db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="property-documentation"> +<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> +<db:section xml:id="method-documentation"> +<db:title>Method Documentation</db:title> +<db:section xml:id="name-method"> +<db:title>void name(Child <db:emphasis>child</db:emphasis>, <db:emphasis>name</db:emphasis>)</db:title> +<db:para>Name a <db:code role="parameter">child</db:code> of this child using <db:code role="parameter">name</db:code>.</db:para> +</db:section> +<db:section xml:id="name-method-1"> +<db:title>void name()</db:title> +<db:para>Name all children with random names.</db:para> +</db:section> +<db:section xml:id="rear-method"> +<db:title>void rear(Child <db:emphasis>child</db:emphasis>, var <db:emphasis>method</db:emphasis> = Strict)</db:title> +<db:para>Do some abstract parenting on <db:code role="parameter">child</db:code> using a specific <db:code role="parameter">method</db:code>.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-doctest.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-doctest.xml new file mode 100644 index 000000000..d39a330bb --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-doctest.xml @@ -0,0 +1,117 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>DocTest QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Represents a doc test case.</db:para> +<db:para>This type was introduced in QDoc.Test 0.9.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import QDoc.Test 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since:</db:term> +<db:listitem> +<db:para>QDoc.Test 0.9</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +<db:section xml:id="introduction"> +<db:title>Introduction</db:title> +<db:para>A documentation test case, itself documented inline in <db:link xlink:href="qml-qdoc-test-doctest.xml">DocTest</db:link>.qml.</db:para> +</db:section> +</db:section> +<db:section xml:id="property-documentation"> +<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> +<db:para><db:emphasis>See also </db:emphasis> +<db:simplelist type="vert" role="see-also"> +<db:member><db:link xlink:href="qml-qdoc-test-doctest.xml#name-prop">name</db:link></db:member> +</db:simplelist> +</db:para> +</db:section> +</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; + // ... +} +</db:programlisting> +</db:section> +</db:section> +<db:section xml:id="signal-documentation"> +<db:title>Signal Documentation</db:title> +<db:section xml:id="completed-signal"> +<db:title>completed()</db:title> +<db:note> +<db:para>The corresponding handler is <db:code>onCompleted</db:code>.</db:para> +</db:note> +</db:section> +<db:section xml:id="foo-signal"> +<db:title>foo(var <db:emphasis>bar</db:emphasis>)</db:title> +<db:para>Signal with parameter <db:code role="parameter">bar</db:code>.</db:para> +<db:note> +<db:para>The corresponding handler is <db:code>onFoo</db:code>.</db:para> +</db:note> +</db:section> +<db:section xml:id="itsHappening-signal"> +<db:title>itsHappening(bool <db:emphasis>really</db:emphasis>)</db:title> +<db:para>Signals that something is <db:code role="parameter">really</db:code> happening.</db:para> +<db:note> +<db:para>The corresponding handler is <db:code>onItsHappening</db:code>.</db:para> +</db:note> +</db:section> +</db:section> +<db:section xml:id="method-documentation"> +<db:title>Method Documentation</db:title> +<db:section xml:id="fail-method"> +<db:title>[since QDoc.Test 1.0] fail(<db:emphasis>message</db:emphasis> = "oops")</db:title> +<db:para>Fails the current test case, with the optional <db:code role="parameter">message</db:code>.</db:para> +<db:para>This method was introduced in QDoc.Test 1.0.</db:para> +</db:section> +<db:section xml:id="fail_hard-method"> +<db:title>fail_hard(<db:emphasis>msg</db:emphasis> = "facepalm", <db:emphasis>option</db:emphasis> = 123)</db:title> +<db:para>Fails the current test case, hard.</db:para> +<db:itemizedlist> +<db:listitem> +<db:para>Prints out <db:code role="parameter">msg</db:code>.</db:para> +</db:listitem> +<db:listitem> +<db:para>Accepts a random <db:code role="parameter">option</db:code>.</db:para> +</db:listitem> +</db:itemizedlist> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-type.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-type.xml new file mode 100644 index 000000000..4422b6962 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-type.xml @@ -0,0 +1,230 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Type QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A QML type documented in a .cpp file.</db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import QDoc.Test 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since:</db:term> +<db:listitem> +<db:para>Qt 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Instantiates:</db:term> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml">Test</db:link></db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Status:</db:term> +<db:listitem> +<db:para><Work In Progress></db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="property-documentation"> +<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: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> +<db:section xml:id="attached-property-documentation"> +<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> +<db:th>Constant</db:th> +<db:th>Description</db:th> +</db:tr> +</db:thead> +<db:tr> +<db:td> +<db:para>Type.NoType</db:para> +</db:td> +<db:td> +<db:para>Nothing</db:para> +</db:td> +</db:tr> +<db:tr> +<db:td> +<db:para>Type.SomeType</db:para> +</db:td> +<db:td> +<db:para>Something</db:para> +</db:td> +</db:tr> +</db:informaltable> +</db:section> +</db:section> +<db:section xml:id="signal-documentation"> +<db:title>Signal Documentation</db:title> +<db:section xml:id="completed-signal"> +<db:title>completed(int <db:emphasis>status</db:emphasis>)</db:title> +<db:para>This signal is emitted when the operation completed with <db:code role="parameter">status</db:code>.</db:para> +<db:note> +<db:para>The corresponding handler is <db:code>onCompleted</db:code>.</db:para> +</db:note> +</db:section> +<db:section xml:id="group.created-signal"> +<db:title>group.created()</db:title> +<db:para>This signal is prefixed with <db:emphasis>group</db:emphasis>.</db:para> +<db:note> +<db:para>The corresponding handler is <db:code>group.onCreated</db:code>.</db:para> +</db:note> +</db:section> +</db:section> +<db:section xml:id="attached-signal-documentation"> +<db:title>Attached Signal Documentation</db:title> +<db:section xml:id="configured-signal"> +<db:title>configured()</db:title> +<db:para>This attached signal is emitted when the type was configured.</db:para> +<db:note> +<db:para>The corresponding handler is <db:code>onConfigured</db:code>.</db:para> +</db:note> +</db:section> +</db:section> +<db:section xml:id="method-documentation"> +<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:section> +<db:section xml:id="copy-method"> +<db:title>Type copy(<db:emphasis>a</db:emphasis>)</db:title> +<db:para>Returns another Type based on <db:code role="parameter">a</db:code>.</db:para> +</db:section> +</db:section> +<db:section xml:id="obsolete"> +<db:title>Obsolete Members for Type</db:title> +<db:para><db:emphasis role="bold">The following members of QML type <db:link xlink:href="qml-qdoc-test-type.xml">Type</db:link> are deprecated.</db:emphasis> We strongly advise against using them in new code.</db:para> +<db:section xml:id="obsolete-method-documentation"> +<db:title>Obsolete Method Documentation</db:title> +<db:section xml:id="deprecatedMethod-method"> +<db:title>deprecatedMethod()</db:title> +<db:para>This method is deprecated since 6.2. We strongly advise against using it in new code.</db:para> +<db:para>This method has no replacement This is a method that should include information about being deprecated and that it has been so since 6.2 in its docs.</db:para> +</db:section> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-yetanotherchild.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-yetanotherchild.xml new file mode 100644 index 000000000..34264b735 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-qdoc-test-yetanotherchild.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>YetAnotherChild QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A type inheriting from internal abstract parent.</db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import QDoc.Test 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since:</db:term> +<db:listitem> +<db:para>Qt 1.1</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="property-documentation"> +<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> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-test-nover-typenoversion.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-test-nover-typenoversion.xml new file mode 100644 index 000000000..87576add4 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-test-nover-typenoversion.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>TypeNoVersion QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Another QML type documented in a .cpp file.</db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import Test.NoVer</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since:</db:term> +<db:listitem> +<db:para>Qt 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Instantiates:</db:term> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-testderived.xml">TestDerived</db:link></db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Status:</db:term> +<db:listitem> +<db:para>Tech Preview</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-progressbar.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-progressbar.xml new file mode 100644 index 000000000..cd0945ec1 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-progressbar.xml @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>ProgressBar QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A component that shows the progress of an event.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import UIComponents 1.0</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +<db:para>A <db:link xlink:href="qml-uicomponents-progressbar.xml">ProgressBar</db:link> shows the linear progress of an event as its <db:link xlink:href="qml-uicomponents-progressbar.xml#value-prop">value</db:link>. The range is specified using the <db:link xlink:href="qml-uicomponents-progressbar.xml#minimum-prop">minimum</db:link> and the <db:link xlink:href="qml-uicomponents-progressbar.xml#maximum-prop">maximum</db:link> values.</db:para> +<db:para>The <db:link xlink:href="qml-uicomponents-progressbar.xml">ProgressBar</db:link> component is part of the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module.</db:para> +<db:para>This documentation is part of the <db:link xlink:href="test-componentset-example.xml">UIComponents</db:link> example.</db:para> +</db:section> +<db:section xml:id="property-documentation"> +<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> +<db:para><db:emphasis>See also </db:emphasis> +<db:simplelist type="vert" role="see-also"> +<db:member><db:link xlink:href="qml-uicomponents-progressbar.xml#secondColor-prop">secondColor</db:link></db:member> +</db:simplelist> +</db:para> +</db:section> +</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> +<db:para><db:emphasis>See also </db:emphasis> +<db:simplelist type="vert" role="see-also"> +<db:member><db:link xlink:href="qml-uicomponents-progressbar.xml#color-prop">color</db:link></db:member> +</db:simplelist> +</db:para> +</db:section> +</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> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-switch.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-switch.xml new file mode 100644 index 000000000..65992be73 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-switch.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Switch QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A component that can be turned on or off.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import UIComponents 1.0</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +<db:para>A toggle switch has two states: an <db:code>on</db:code> and an <db:code>off</db:code> state. The <db:code>off</db:code> state is when the <db:link xlink:href="qml-uicomponents-switch.xml#on-prop">on</db:link> property is set to <db:code>false</db:code>.</db:para> +<db:para>The ToggleSwitch component is part of the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module.</db:para> +<db:para>This documentation is part of the <db:link xlink:href="test-componentset-example.xml">UIComponents</db:link> example.</db:para> +</db:section> +<db:section xml:id="property-documentation"> +<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> +<db:section xml:id="method-documentation"> +<db:title>Method Documentation</db:title> +<db:section xml:id="toggle-method"> +<db:title>toggle()</db:title> +<db:para>A method to toggle the switch. If the switch is <db:code>on</db:code>, the toggling it will turn it <db:code>off</db:code>. Toggling a switch in the <db:code>off</db:code> position will turn it <db:code>on</db:code>.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-tabwidget.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-tabwidget.xml new file mode 100644 index 000000000..61644e64d --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/qml-uicomponents-tabwidget.xml @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>TabWidget QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A widget that places its children as tabs.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import UIComponents 1.0</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +<db:para>A <db:link xlink:href="qml-uicomponents-tabwidget.xml">TabWidget</db:link> places its children as tabs in a view. Selecting a tab involves selecting the tab at the top.</db:para> +<db:para>The <db:link xlink:href="qml-uicomponents-tabwidget.xml">TabWidget</db:link> component is part of the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module.</db:para> +<db:para>This documentation is part of the <db:link xlink:href="test-componentset-example.xml">UIComponents</db:link> example.</db:para> +<db:section xml:id="adding-tabs"> +<db:title>Adding Tabs</db:title> +<db:para>To add a tab, declare the tab as a child of the <db:link xlink:href="qml-uicomponents-tabwidget.xml">TabWidget</db:link>.</db:para> +<db:programlisting language="cpp">TabWidget { + id: tabwidget + + Rectangle { + id: tab1 + color: &quot;red&quot; + //... omitted + } + Rectangle { + id: tab2 + color: &quot;blue&quot; + //... omitted + } + +} +</db:programlisting> +</db:section> +</db:section> +<db:section xml:id="property-documentation"> +<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 +</db:programlisting> +<db:para>Note that the property must be initialized to a value.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/test-componentset-example.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/test-componentset-example.xml new file mode 100644 index 000000000..add2bcae1 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/test-componentset-example.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>QML Documentation Example</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Example for documenting QML types.</db:para> +</db:abstract> +</db:info> +<db:para>This example demonstrates one of the ways to document QML types. It also generates a warning about a missing example image, on purpose.</db:para> +<db:para>In particular, there are sample types that are documented with QDoc commands comments. There are documentation comments for the QML types and their public interfaces. The types are grouped into a module, the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module.</db:para> +<db:para>The uicomponents.qdoc file generates the overview page for the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module page.</db:para> +<db:para>The generated documentation is available in the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module.</db:para> +<db:section xml:id="qml-class"> +<db:title>QML Class</db:title> +<db:para>The QML types use the \qmltype to document the type. In addition, they have the \inmodule command in order for QDoc to associate them to the <db:code>UIComponents</db:code> module.</db:para> +<db:para>QDoc uses the \brief command to place a basic description when listing the types.</db:para> +</db:section> +<db:section xml:id="properties-signals-handlers-and-methods"> +<db:title>Properties, Signals, Handlers, and Methods</db:title> +<db:para>The types have their properties, signals, handlers, and methods defined in their respective QML files. QDoc associates the properties and methods to the types, therefore, you only need to place the documentation above the property, method, or signal.</db:para> +<db:para>To document the type of a <db:emphasis>property alias</db:emphasis>, you must use the \qmlproperty command to specify the data type.</db:para> +<db:programlisting language="cpp">\qmlproperty int anAliasedProperty +An aliased property of type int. +</db:programlisting> +<db:section xml:id="internal-documentation"> +<db:title>Internal Documentation</db:title> +<db:para>You may declare that a documentation is for internal use by placing the \internal command after the beginning QDoc comment <db:code>/*</db:code>. QDoc will prevent the internal documentation from appearing in the public API.</db:para> +<db:para>If you wish to omit certain parts of the documentation, you may use the \omit and \endomit command.</db:para> +</db:section> +</db:section> +<db:section xml:id="qml-types-with-c-implementation"> +<db:title>QML Types with C++ Implementation</db:title> +<db:para>This example only demonstrates the documentation for types in QML files, but the regular QML commands may be placed inside C++ classes to define the public API of the QML type.</db:para> +</db:section> +<db:section> +<db:title>List of Files</db:title> +<db:para>Files:</db:para> +<db:section> +<db:title>List of Files</db:title> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="componentset/ProgressBar.qml">componentset/ProgressBar.qml</db:link></db:para></db:listitem> +<db:listitem> +<db:para><db:link xlink:href="componentset/Switch.qml">componentset/Switch.qml</db:link></db:para></db:listitem> +<db:listitem> +<db:para><db:link xlink:href="componentset/TabWidget.qml">componentset/TabWidget.qml</db:link></db:para></db:listitem> +<db:listitem> +<db:para><db:link xlink:href="componentset/componentset.pro">componentset/componentset.pro</db:link></db:para></db:listitem> +<db:listitem> +<db:para><db:link xlink:href="componentset/componentset.qml">componentset/componentset.qml</db:link></db:para></db:listitem> +</db:itemizedlist> +</db:section> +</db:section></db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/test-nover-qmlmodule.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/test-nover-qmlmodule.xml new file mode 100644 index 000000000..1cd079200 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/test-nover-qmlmodule.xml @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Versionless QML Module</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>QML Types for the Test module without version.</db:para> +<db:para>This module is in <db:emphasis>Tech Preview</db:emphasis> state.</db:para> +<db:para>This module was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:para>This module is in <db:emphasis>Tech Preview</db:emphasis> state.</db:para> +<db:para>This module was introduced in Qt 1.1.</db:para> +<db:anchor xml:id="details"/> +<db:variablelist role="members"> +<db:varlistentry> +<db:term><db:link xlink:href="qml-test-nover-typenoversion.xml" xlink:role="">TypeNoVersion</db:link></db:term> +<db:listitem> +<db:para>Another QML type documented in a .cpp file.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testcpp-module.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testcpp-module.xml new file mode 100644 index 000000000..0026854b2 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testcpp-module.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>QDoc Test C++ Classes</db:title> +<db:productname>TestCPP</db:productname> +<db:titleabbrev>TestCPP Reference Documentation</db:titleabbrev> +<db:abstract> +<db:para>A test module page.</db:para> +<db:para>This module was introduced in Qt 2.0.</db:para> +</db:abstract> +</db:info> +<db:para>A test module page.</db:para> +<db:para>This module was introduced in Qt 2.0.</db:para> +<db:section xml:id="namespaces"> +<db:title>Namespaces</db:title> +<db:variablelist role="namespaces"> +<db:varlistentry> +<db:term><db:link xlink:href="crossmoduleref.xml" xlink:role="namespace">CrossModuleRef</db:link></db:term> +<db:listitem> +<db:para>Namespace that has documented functions in multiple modules.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="testqdoc.xml" xlink:role="namespace">TestQDoc</db:link></db:term> +<db:listitem> +<db:para>A namespace.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:section> +<db:section xml:id="classes"> +<db:title>Classes</db:title> +<db:variablelist role="classes"> +<db:varlistentry> +<db:term><db:link xlink:href="testqdoc-test.xml" xlink:role="class">TestQDoc::Test</db:link></db:term> +<db:listitem> +<db:para>A class in a namespace.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="testqdoc-testderived.xml" xlink:role="class">TestQDoc::TestDerived</db:link></db:term> +<db:listitem> +<db:para>A derived class in a namespace.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:section> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +<db:note> +<db:para>This is just a test. /* Look, Ma! {I'm made of arguments!} */</db:para> +</db:note> +<db:section xml:id="linking-to-function-like-things"> +<db:title>Linking to function-like things</db:title> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#someFunctionDefaultArg">someFunctionDefaultArg</db:link>()</db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#QDOCTEST_MACRO2">QDOCTEST_MACRO2</db:link>()</db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#QDOCTEST_MACRO2">QDOCTEST_MACRO2</db:link>(int &x)</db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testcpp-module.xml#section">section()</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testcpp-module.xml#section">section() is a section title</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#Test">open( parenthesis</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="https://en.cppreference.com/w/cpp/utility/move">C++11 added std::move(T&& t)</db:link></db:para> +</db:listitem> +</db:itemizedlist> +<db:section xml:id="section"> +<db:title>section()</db:title> +</db:section> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc-test.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc-test.xml new file mode 100644 index 000000000..06b8f5816 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc-test.xml @@ -0,0 +1,358 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Test Class</db:title> +<db:subtitle>TestQDoc::Test</db:subtitle> +<db:productname>TestCPP</db:productname> +<db:titleabbrev>TestCPP Reference Documentation</db:titleabbrev> +<db:abstract> +<db:para>A class in a namespace.</db:para> +<db:para>This class was introduced in Qt 2.0.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Header</db:term> +<db:listitem> +<db:para>Test</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since</db:term> +<db:listitem> +<db:para>Qt 2.0</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>CMake</db:term> +<db:listitem> +<db:para>find_package(Qt6 REQUIRED COMPONENTS QDocTest)</db:para> +<db:para>target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>qmake</db:term> +<db:listitem> +<db:para>QT += testcpp</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Inherited By</db:term> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-testderived.xml" xlink:role="class">TestQDoc::TestDerived</db:link></db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Group</db:term> +<db:listitem> +<db:para><db:para>Test is part of <db:simplelist><db:member>testgroup</db:member><db:member><db:link xlink:href="cpptypes.xml">Test C++ Types</db:link></db:member></db:simplelist></db:para> +</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="member-type-documentation"> +<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> +<db:section xml:id="member-function-documentation"> +<db:title>Member Function Documentation</db:title> +<db:section xml:id="overload"> +<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"> +<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> +<db:para>—You can also start a new paragraph with an em dash, if you want to.</db:para> +<db:section> +<db:title>See Also</db:title> +<db:para><db:emphasis>See also </db:emphasis> +<db:simplelist type="vert" role="see-also"> +<db:member><db:link xlink:href="testqdoc-test.xml#methodWithEnDashInItsDocs">methodWithEnDashInItsDocs</db:link></db:member> +</db:simplelist> +</db:para> +</db:section> +</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. +</db:programlisting> +<db:para>...as it would be silly if this would output –i instead of <db:code>--i</db:code>.</db:para> +<db:para>-----------------------------------------------------------------------</db:para> +<db:para>It still allows people to add a bunch of dashes, though, without replacing them all with a series of en dashes. Of course, they might want to use the \hr command instead, like this:</db:para> +<db:para>– You can also start a new paragraph with an en dash, if you want to.</db:para> +<db:section> +<db:title>See Also</db:title> +<db:para><db:emphasis>See also </db:emphasis> +<db:simplelist type="vert" role="see-also"> +<db:member><db:link xlink:href="">methodWithEnDashInItsDocs</db:link></db:member> +</db:simplelist> +</db:para> +</db:section> +</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> +<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 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> +<db:section xml:id="macro-documentation"> +<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> +</db:section> +<db:section xml:id="obsolete"> +<db:title>Obsolete Members for Test</db:title> +<db:para><db:emphasis role="bold">The following members of class <db:link xlink:href="testqdoc-test.xml">Test</db:link> are deprecated.</db:emphasis> We strongly advise against using them in new code.</db:para> +<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>TestQDoc::Test &Test::operator++()</db:title> +<db:bridgehead renderas="sect2" xml:id="operator--">TestQDoc::Test &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>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> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc-testderived.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc-testderived.xml new file mode 100644 index 000000000..5b792c60d --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc-testderived.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>TestDerived Class</db:title> +<db:subtitle>TestQDoc::TestDerived</db:subtitle> +<db:productname>TestCPP</db:productname> +<db:titleabbrev>TestCPP Reference Documentation</db:titleabbrev> +<db:abstract> +<db:para>A derived class in a namespace.</db:para> +<db:para>This class was introduced in Qt 2.0.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Header</db:term> +<db:listitem> +<db:para>TestDerived</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since</db:term> +<db:listitem> +<db:para>Qt 2.0</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>CMake</db:term> +<db:listitem> +<db:para>find_package(Qt6 REQUIRED COMPONENTS QDocTest)</db:para> +<db:para>target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>qmake</db:term> +<db:listitem> +<db:para>QT += testcpp</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Inherits</db:term> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml" xlink:role="class">TestQDoc::Test</db:link></db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="member-type-documentation"> +<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> +<db:section xml:id="member-function-documentation"> +<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> +<db:section xml:id="obsolete"> +<db:title>Obsolete Members for TestDerived</db:title> +<db:para><db:emphasis role="bold">The following members of class <db:link xlink:href="testqdoc-testderived.xml">TestDerived</db:link> are deprecated.</db:emphasis> We strongly advise against using them in new code.</db:para> +<db:section xml:id="obsolete-member-function-documentation"> +<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> +</db:section> +</db:section> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc.xml new file mode 100644 index 000000000..7fd926ed1 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/testqdoc.xml @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>TestQDoc Namespace</db:title> +<db:productname>TestCPP</db:productname> +<db:titleabbrev>TestCPP Reference Documentation</db:titleabbrev> +<db:abstract> +<db:para>A namespace.</db:para> +<db:para>This namespace was introduced in Qt 2.0.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Header</db:term> +<db:listitem> +<db:para>TestCPP</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since</db:term> +<db:listitem> +<db:para>Qt 2.0</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>CMake</db:term> +<db:listitem> +<db:para>find_package(Qt6 REQUIRED COMPONENTS QDocTest)</db:para> +<db:para>target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>qmake</db:term> +<db:listitem> +<db:para>QT += testcpp</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +<db:section xml:id="usage"> +<db:title>Usage</db:title> +<db:para>This namespace is for testing QDoc output.</db:para> +</db:section> +</db:section> +<db:section xml:id="classes"> +<db:title>Classes</db:title> +<db:section> +<db:title>class <db:link xlink:href="testqdoc-test.xml" xlink:role="class">Test</db:link></db:title> +<db:para>A class in a namespace.</db:para> +</db:section> +<db:section> +<db:title>class <db:link xlink:href="testqdoc-testderived.xml" xlink:role="class">TestDerived</db:link></db:title> +<db:para>A derived class in a namespace.</db:para> +</db:section> +</db:section> +<db:section xml:id="macro-documentation"> +<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> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbookext/uicomponents-qmlmodule.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/uicomponents-qmlmodule.xml new file mode 100644 index 000000000..f00b3d3f7 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbookext/uicomponents-qmlmodule.xml @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>UI Components</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Basic set of UI components.</db:para> +</db:abstract> +</db:info> +<db:anchor xml:id="details"/> +<db:para>This is a listing of a list of UI components implemented by QML types. These files are available for general import and they are based on the Qt Quick Code Samples.</db:para> +<db:para>This module is part of the <db:link xlink:href="test-componentset-example.xml">UIComponents</db:link> example.</db:para> +<db:variablelist role="members"> +<db:varlistentry> +<db:term><db:link xlink:href="qml-uicomponents-progressbar.xml" xlink:role="">ProgressBar</db:link></db:term> +<db:listitem> +<db:para>A component that shows the progress of an event.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="qml-uicomponents-switch.xml" xlink:role="">Switch</db:link></db:term> +<db:listitem> +<db:para>A component that can be turned on or off.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="qml-uicomponents-tabwidget.xml" xlink:role="">TabWidget</db:link></db:term> +<db:listitem> +<db:para>A widget that places its children as tabs.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:article> diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/docbook.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/docbook.qdocconf index 68afd29e8..9bd6c7bba 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/configs/docbook.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/docbook.qdocconf @@ -1,6 +1,6 @@ outputformats = DocBook -DocBook.nosubdirs = true -DocBook.outputsubdir = docbook +DocBook.nosubdirs = true +DocBook.outputsubdir = docbook # TODO: DocBook generator has trouble handling shared comment nodes # allow two warnings related to these diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext.qdocconf new file mode 100644 index 000000000..c54eb11c5 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext.qdocconf @@ -0,0 +1,8 @@ +outputformats = DocBook +DocBook.nosubdirs = true +DocBook.outputsubdir = docbookext +DocBook.usedocbookextensions = true + +# TODO: DocBook generator has trouble handling shared comment nodes +# allow two warnings related to these +warninglimit = 2 diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_test.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_test.qdocconf new file mode 100644 index 000000000..233bd60bb --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_test.qdocconf @@ -0,0 +1,3 @@ +include(config.qdocconf) +include(test.qdocconf) +include(docbookext.qdocconf) diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_testcpp.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_testcpp.qdocconf new file mode 100644 index 000000000..19b2af6a9 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_testcpp.qdocconf @@ -0,0 +1,3 @@ +include(config.qdocconf) +include(testcpp.qdocconf) +include(docbookext.qdocconf) diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_testqml.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_testqml.qdocconf new file mode 100644 index 000000000..36b22b3ad --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/docbookext_testqml.qdocconf @@ -0,0 +1,3 @@ +include(config.qdocconf) +include(testqml.qdocconf) +include(docbookext.qdocconf) diff --git a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp index 785fad427..ea0c47e1a 100644 --- a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp +++ b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp @@ -29,10 +29,13 @@ private slots: void webXmlFromCppBug80259(); void illformated_documentation(); - // DocBook generator + // DocBook generator (wiht and without extensions) void docBookFromQDocFile(); void docBookFromCpp(); void docBookFromQml(); + void docBookWithExtensionsFromQDocFile(); + void docBookWithExtensionsFromCpp(); + void docBookWithExtensionsFromQml(); // Output format independent tests void autoNavigation(); @@ -342,6 +345,43 @@ void tst_generatedOutput::docBookFromQml() "docbook/qml-int.xml"); } +void tst_generatedOutput::docBookWithExtensionsFromQDocFile() +{ + testAndCompare("testdata/configs/docbookext_test.qdocconf", + "docbookext/qdoctests-qdocfileoutput.xml " + "docbookext/qdoctests-qdocmanuallikefileoutput.xml " + "docbookext/qdoctests-qdocfileoutput-linking.xml " + "docbookext/qdoctests-qdocfileoutput-exhaustive.xml"); +} + +void tst_generatedOutput::docBookWithExtensionsFromCpp() +{ + testAndCompare("testdata/configs/docbookext_testcpp.qdocconf", + "docbookext/testcpp-module.xml " + "docbookext/testqdoc-test.xml " + "docbookext/testqdoc-testderived.xml " + "docbookext/testqdoc.xml"); +} + +void tst_generatedOutput::docBookWithExtensionsFromQml() +{ + testAndCompare("testdata/configs/docbookext_testqml.qdocconf", + "docbookext/test-componentset-example.xml " + "docbookext/uicomponents-qmlmodule.xml " + "docbookext/qdoc-test-qmlmodule.xml " + "docbookext/test-nover-qmlmodule.xml " + "docbookext/qml-qdoc-test-abstractparent.xml " + "docbookext/qml-qdoc-test-child.xml " + "docbookext/qml-qdoc-test-yetanotherchild.xml " + "docbookext/qml-qdoc-test-doctest.xml " + "docbookext/qml-qdoc-test-type.xml " + "docbookext/qml-test-nover-typenoversion.xml " + "docbookext/qml-uicomponents-progressbar.xml " + "docbookext/qml-uicomponents-switch.xml " + "docbookext/qml-uicomponents-tabwidget.xml " + "docbookext/qml-int.xml"); +} + void tst_generatedOutput::autoNavigation() { // Same expected files as htmlFromQdocFile, but with auto-generated navigation links |