diff options
Diffstat (limited to 'src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected')
141 files changed, 8778 insertions, 0 deletions
diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/autolinking.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/autolinking.xml new file mode 100644 index 000000000..1fde6fac7 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/autolinking.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Autolinking</db:title> +<db:productname>Test</db:productname> +<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:section xml:id="testqdoc"> +<db:title>TestQDoc</db:title> +<db:para>The string <db:link xlink:href="testqdoc.xml">TestQDoc</db:link> links to the C++ namespace unless linking explicitly, <db:link xlink:href="autolinking.xml#testqdoc">like this</db:link>, or <db:link xlink:href="testqdoc.xml">this</db:link>. Also,</db:para> +<db:para>Autolinks:</db:para> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-testderived.xml">TestQDoc::TestDerived</db:link></db:para> +</db:listitem> +</db:itemizedlist> +<db:para>Explicit links:</db:para> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-testderived.xml">TestQDoc::TestDerived</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="obsolete-classes.xml#testqdoc">Obsolete Classes#TestQDoc</db:link></db:para> +</db:listitem> +</db:itemizedlist> +</db:section> +<db:section xml:id="someprop"> +<db:title>someProp</db:title> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/classes.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/classes.xml new file mode 100644 index 000000000..68d7a4616 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/classes.xml @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Classes</db:title> +<db:productname>Test</db:productname> +<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:variablelist role="annotatedclasses"> +<db:varlistentry> +<db:term><db:link xlink:href="seenclass.xml" xlink:role="class">SeenClass</db:link></db:term> +<db:listitem> +<db:para>A public but undocumented class.</db:para> +</db:listitem> +</db:varlistentry> +<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 class in a namespace, derived from Test.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/cpptypes.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/cpptypes.xml new file mode 100644 index 000000000..727d59fd0 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/cpptypes.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Test C++ Types</db:title> +<db:productname>Test</db:productname> +<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:anchor xml:id="details"/> +<db:itemizedlist role="testgroup"> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml" xlink:role="class">TestQDoc::Test</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#QDOCTEST_MACRO2" xlink:role="function">TestQDoc::Test::QDOCTEST_MACRO2</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#operator-eq" xlink:role="function">TestQDoc::Test::operator=()</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#someFunctionDefaultArg" xlink:role="function">TestQDoc::Test::someFunctionDefaultArg()</db:link></db:para> +</db:listitem> +</db:itemizedlist> +<db:variablelist role="members"> +<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:variablelist> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/crossmoduleref.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/crossmoduleref.xml new file mode 100644 index 000000000..19e6e28f2 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/crossmoduleref.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">CrossModuleRef Namespace</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Namespace that has documented functions in multiple modules.</db:para> +<db:para>This namespace was introduced in Qt 3.0.</db:para> +</db:abstract> +</db:info> +<db:variablelist its:translate="no"> +<db:varlistentry> +<db:term>Header</db:term> +<db:listitem> +<db:para>CrossModuleRef</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since</db:term> +<db:listitem> +<db:para>Qt 3.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> +<db:section xml:id="function-documentation"> +<db:title>Function Documentation</db:title> +<db:section xml:id="documentMe"> +<db:title its:translate="no">void CrossModuleRef::documentMe()</db:title> +<db:methodsynopsis> +<db:void/> +<db:methodname>documentMe</db:methodname> +<db:void/> +<db:synopsisinfo role="meta">plain</db:synopsisinfo> +<db:synopsisinfo role="signature">void documentMe()</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>Document me!</db:para> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/images/leonardo-da-vinci.png b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/images/leonardo-da-vinci.png Binary files differnew file mode 100644 index 000000000..854acb4ca --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/images/leonardo-da-vinci.png diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/obsolete-classes.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/obsolete-classes.xml new file mode 100644 index 000000000..f90bcc5ca --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/obsolete-classes.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Obsolete Classes</db:title> +<db:productname>Test</db:productname> +<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:section xml:id="classes-with-obsolete-members"> +<db:title>Classes with obsolete members</db:title> +<db:variablelist role="obsoletecppmembers"> +<db:varlistentry> +<db:term><db:emphasis role="bold">T</db:emphasis></db:term> +<db:listitem> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml" role="class">Test</db:link> (<db:link xlink:href="testqdoc.xml" xlink:role="namespace">TestQDoc</db:link>)</db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-testderived.xml" role="class">TestDerived</db:link> (<db:link xlink:href="testqdoc.xml" xlink:role="namespace">TestQDoc</db:link>)</db:para> +</db:listitem> +</db:itemizedlist> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="testqdoc"> +<db:title>TestQDoc</db:title> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qdoc-test-qmlmodule.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qdoc-test-qmlmodule.xml new file mode 100644 index 000000000..793dc3ea1 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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-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-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-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: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-int.xml" xlink:role="">int</db:link></db:term> +<db:listitem> +<db:para>An integer value type.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-int.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-int.xml new file mode 100644 index 000000000..f5e99f6ab --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-abstractparent.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-abstractparent.xml new file mode 100644 index 000000000..695c7bfe4 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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()</db:title> +<db:para>Name all children with random names.</db:para> +</db:section> +<db:section xml:id="name-method-1"> +<db:title>void name(Child <db:emphasis>child</db:emphasis>, <db:emphasis>name</db:emphasis>)</db:title> +<db:para>Name a <db:code its:translate="no" role="parameter">child</db:code> using <db:code its:translate="no" role="parameter">name</db:code>.</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 its:translate="no" role="parameter">child</db:code> using a specific <db:code its:translate="no" role="parameter">method</db:code>.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-child.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-child.xml new file mode 100644 index 000000000..26a78038e --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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 its:translate="no" role="parameter">child</db:code> of this child using <db:code its:translate="no" role="parameter">name</db:code>.</db:para> +</db:section> +<db:section xml:id="name-method"> +<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 its:translate="no" role="parameter">child</db:code> using a specific <db:code its:translate="no" role="parameter">method</db:code>.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-doctest.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-doctest.xml new file mode 100644 index 000000000..9a021a6fc --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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 DocTest.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" its:translate="no">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 its:translate="no" 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 its:translate="no" 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 its:translate="no" 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 its:translate="no" role="parameter">msg</db:code>.</db:para> +</db:listitem> +<db:listitem> +<db:para>Accepts a random <db:code its:translate="no" role="parameter">option</db:code>.</db:para> +</db:listitem> +</db:itemizedlist> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-oldtype.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-oldtype.xml new file mode 100644 index 000000000..e2d1059b4 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-oldtype.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">OldType QML Type</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Deprecated old type.</db:para> +<db:para><db:emphasis role="bold">This type is deprecated since QDoc.Test 1.0. We strongly advise against using it in new code.</db:emphasis></db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist its:translate="no"> +<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>Status:</db:term> +<db:listitem> +<db:para>Deprecated since 1.0</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:para><db:emphasis role="bold">This type is deprecated since QDoc.Test 1.0. We strongly advise against using it in new code.</db:emphasis></db:para> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-type.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-type.xml new file mode 100644 index 000000000..826abfe3b --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-type.xml @@ -0,0 +1,237 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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>In C++:</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 its:translate="no">Type.NoType</db:para> +</db:td> +<db:td> +<db:para>Nothing</db:para> +</db:td> +</db:tr> +<db:tr> +<db:td> +<db:para its:translate="no">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 its:translate="no" 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 its:translate="no" role="parameter">a</db:code>.</db:para> +</db:section> +<db:section xml:id="futureDeprecated-method"> +<db:title>[until 6.3] futureDeprecated()</db:title> +<db:para>This method is scheduled for deprecation in version 6.3.</db:para> +<db:para>Use something else instead.</db:para> +<db:para>This is a method that's marked for deprecation in a future version.</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>[deprecated in 6.2] deprecatedMethod()</db:title> +<db:para>This method is deprecated since QDoc.Test 6.2. We strongly advise against using it in new code.</db:para> +<db:para>This method has no replacement.</db:para> +<db:para>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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-yetanotherchild.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-yetanotherchild.xml new file mode 100644 index 000000000..040c7360b --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-test-nover-doctest.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-test-nover-doctest.xml new file mode 100644 index 000000000..d719d9f6f --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-test-nover-doctest.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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>Shadows the type name in QDoc.Test module.</db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist its:translate="no"> +<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>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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-test-nover-typenoversion.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-test-nover-typenoversion.xml new file mode 100644 index 000000000..581207402 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-test-nover-typenoversion.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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>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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-themodule-thetype.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-themodule-thetype.xml new file mode 100644 index 000000000..b8a31eb9f --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-themodule-thetype.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">TheType 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 test project for QDoc build artifacts.</db:para></db:abstract> +</db:info> +<db:variablelist its:translate="no"> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import TheModule</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>In C++:</db:term> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-testderived.xml">TestDerived</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="name-prop"> +<db:title>[read-only] name : string</db:title> +<db:fieldsynopsis> +<db:type>string</db:type> +<db:varname>name</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>Read-only status of this property is resolved from Q_PROPERTY.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-uicomponents-progressbar.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-uicomponents-progressbar.xml new file mode 100644 index 000000000..f1a8d4129 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-uicomponents-switch.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-uicomponents-switch.xml new file mode 100644 index 000000000..2ad3a31b5 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-uicomponents-tabwidget.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-uicomponents-tabwidget.xml new file mode 100644 index 000000000..f0bdf582a --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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 its:translate="no"> +<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" its:translate="no">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" its:translate="no">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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qmlmodules.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qmlmodules.xml new file mode 100644 index 000000000..af130ca0c --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qmlmodules.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>QML Modules</db:title> +<db:productname>Test</db:productname> +<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:variablelist role="qml-modules"> +<db:varlistentry> +<db:term><db:link xlink:href="test-empty-qmlmodule.xml" xlink:role="">No QML Types Here</db:link></db:term> +<db:listitem> +<db:para>A QML module with no member types.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="qdoc-test-qmlmodule.xml" xlink:role="">QDoc.Test QML Module</db:link></db:term> +<db:listitem> +<db:para>QML Types for the Test module.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="themodule-qmlmodule.xml" xlink:role="">TheModule</db:link></db:term> +<db:listitem> +<db:para></db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="uicomponents-qmlmodule.xml" xlink:role="">UI Components</db:link></db:term> +<db:listitem> +<db:para>Basic set of UI components.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="test-nover-qmlmodule.xml" xlink:role="">Versionless QML Module</db:link></db:term> +<db:listitem> +<db:para>QML Types for the Test module without version.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="qml-types"> +<db:title>QML types</db:title> +<db:variablelist role="qmltypesbymodule QDoc.Test"> +<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-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-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: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:variablelist> +</db:section> +<db:section xml:id="qml-value-types"> +<db:title>QML value types</db:title> +<db:simplelist> +<db:member><db:link xlink:href="i">I</db:link></db:member> +</db:simplelist> +<db:variablelist role="qmlvaluetypes"> +<db:varlistentry xml:id="i"> +<db:term><db:emphasis role="bold">I</db:emphasis></db:term> +<db:listitem> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="qml-int.xml">int</db:link></db:para> +</db:listitem> +</db:itemizedlist> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:variablelist role="qmlvaluetypesbymodule QDoc.Test"> +<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:variablelist> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/seenclass.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/seenclass.xml new file mode 100644 index 000000000..abb697567 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/seenclass.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">SeenClass Class</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A public but undocumented class.</db:para> +<db:para>This class was introduced in Qt 2.0.</db:para> +</db:abstract> +</db:info> +<db:variablelist its:translate="no"> +<db:varlistentry> +<db:term>Header</db:term> +<db:listitem> +<db:para>SeenClass</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> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-cmakelists-txt.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-cmakelists-txt.xml new file mode 100644 index 000000000..a29ba9a12 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-cmakelists-txt.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>CMake Example Project</db:title> +<db:productname>Test</db:productname> +<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:programlisting language="cpp" its:translate="no">cmake_minimum_required(VERSION 3.16) +project (QDOCTEST) + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-example.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-example.xml new file mode 100644 index 000000000..549aa1fec --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-example.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>CMake Example Project</db:title> +<db:productname>Test</db:productname> +<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:mediaobject> +<db:imageobject> +<db:imagedata fileref="images/leonardo-da-vinci.png"/> +</db:imageobject> +</db:mediaobject> +<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="cmaketest/CMakeLists.txt">cmaketest/CMakeLists.txt</db:link></db:para></db:listitem> +<db:listitem> +<db:para><db:link xlink:href="cmaketest/main.cpp">cmaketest/main.cpp</db:link></db:para></db:listitem> +</db:itemizedlist> +</db:section> +</db:section></db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-main-cpp.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-main-cpp.xml new file mode 100644 index 000000000..d7e7029a2 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-cmaketest-main-cpp.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>CMake Example Project</db:title> +<db:productname>Test</db:productname> +<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:programlisting language="cpp" its:translate="no">void main(){} + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-componentset-pro.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-componentset-pro.xml new file mode 100644 index 000000000..606a5ac94 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-componentset-pro.xml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" 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:programlisting language="cpp" its:translate="no">SOURCES = componentset.pro \ + ProgressBar.qml \ + Switch.qml \ + TabWidget.qml \ + uicomponents.qdoc + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-componentset-qml.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-componentset-qml.xml new file mode 100644 index 000000000..34f5e59b0 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-componentset-qml.xml @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" 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:programlisting language="qml" its:translate="no">// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 + +import QtQuick 2.0 + +Item { +} + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-example.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-example.xml new file mode 100644 index 000000000..a5ffd1cd0 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" 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" its:translate="no">\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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-progressbar-qml.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-progressbar-qml.xml new file mode 100644 index 000000000..e284bd51a --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-progressbar-qml.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" 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:programlisting language="qml" its:translate="no">// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + +import QtQuick 1.0 + +/*! + \qmltype ProgressBar + \inqmlmodule UIComponents + \brief A component that shows the progress of an event. + + A ProgressBar shows the linear progress of an event as its \l value. + The range is specified using the \l {minimum} and the \l{maximum} values. + + The ProgressBar component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. +*/ +Item { + id: progressbar + + /*! + The minimum value of the ProgressBar range. + The \l value must not be less than this value. + */ + property int minimum: 0 + + /*! + The maximum value of the ProgressBar range. + The \l value must not be more than this value. + */ + property int maximum: 100 + + /*! + The value of the progress. + */ + property int value: 0 + + /*! + \qmlproperty color ProgressBar::color + The color of the ProgressBar's gradient. Must bind to a color type. + + \omit + The &quot;\qmlproperty &lt;type&gt; &lt;property name&gt;&quot; is needed because + property alias need to have their types manually entered. + + QDoc will not publish the documentation within omit and endomit. + \endomit + + \sa secondColor + */ + property alias color: gradient1.color + + /*! + \qmlproperty color ProgressBar::secondColor + The second color of the ProgressBar's gradient. + Must bind to a color type. + + \omit + The &quot;\qmlproperty &lt;type&gt; &lt;property name&gt;&quot; is needed because + property alias need to have their types manually entered. + + QDoc will not publish the documentation within omit and endomit. + \endomit + + \sa color + */ + property alias secondColor: gradient2.color + + width: 250; height: 23 + clip: true + + Rectangle { + id: highlight + + /*! + An internal documentation comment. The widthDest property is not + a public API and therefore will not be exposed. + */ + property int widthDest: ((progressbar.width * (value - minimum)) / (maximum - minimum) - 6) + + width: highlight.widthDest + Behavior on width { SmoothedAnimation { velocity: 1200 } } + + anchors { left: parent.left; top: parent.top; bottom: parent.bottom; margins: 3 } + radius: 1 + gradient: Gradient { + GradientStop { id: gradient1; position: 0.0 } + GradientStop { id: gradient2; position: 1.0 } + } + + } + Text { + anchors { right: highlight.right; rightMargin: 6; verticalCenter: parent.verticalCenter } + color: &quot;white&quot; + font.bold: true + text: Math.floor((value - minimum) / (maximum - minimum) * 100) + '%' + } +} + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-switch-qml.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-switch-qml.xml new file mode 100644 index 000000000..93083a18a --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-switch-qml.xml @@ -0,0 +1,116 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" 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:programlisting language="qml" its:translate="no">// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + +import QtQuick 1.0 + +/*! + \qmltype ToggleSwitch + \inqmlmodule UIComponents + \brief A component that can be turned on or off. + + A toggle switch has two states: an \c on and an \c off state. The \c off + state is when the \l on property is set to \c false. + + The ToggleSwitch component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. + +*/ +Item { + id: toggleswitch + width: background.width; height: background.height + + /*! + Indicates the state of the switch. If \c false, then the switch is in + the \c off state. + + \omit + The \qmlproperty &lt;type&gt; &lt;propertyname&gt; is not necessary as QDoc + will associate this property to the ToggleSwitch + + QDoc will not publish the documentation within omit and endomit. + \endomit + */ + property bool on: false + + /*! + A method to toggle the switch. If the switch is \c on, the toggling it + will turn it \c off. Toggling a switch in the \c off position will + turn it \c on. + */ + function toggle() { + if (toggleswitch.state == &quot;on&quot;) + toggleswitch.state = &quot;off&quot;; + else + toggleswitch.state = &quot;on&quot;; + } + + /*! + \internal + + An internal function to synchronize the switch's internals. This + function is not for public access. The \internal command will + prevent QDoc from publishing this comment in the public API. + */ + function releaseSwitch() { + if (knob.x == 1) { + if (toggleswitch.state == &quot;off&quot;) return; + } + if (knob.x == 78) { + if (toggleswitch.state == &quot;on&quot;) return; + } + toggle(); + } + + Rectangle { + id: background + width: 130; height: 48 + radius: 48 + color: &quot;lightsteelblue&quot; + MouseArea { anchors.fill: parent; onClicked: toggle() } + } + + Rectangle { + id: knob + width: 48; height: 48 + radius: width + color: &quot;lightblue&quot; + + MouseArea { + anchors.fill: parent + drag.target: knob; drag.axis: Drag.XAxis; drag.minimumX: 1; drag.maximumX: 78 + onClicked: toggle() + onReleased: releaseSwitch() + } + } + + states: [ + State { + name: &quot;on&quot; + PropertyChanges { target: knob; x: 78 } + PropertyChanges { target: toggleswitch; on: true } + }, + State { + name: &quot;off&quot; + PropertyChanges { target: knob; x: 1 } + PropertyChanges { target: toggleswitch; on: false } + } + ] + + transitions: Transition { + NumberAnimation { properties: &quot;x&quot;; easing.type: Easing.InOutQuad; duration: 200 } + } +} + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-tabwidget-qml.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-tabwidget-qml.xml new file mode 100644 index 000000000..24c672b9f --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-componentset-tabwidget-qml.xml @@ -0,0 +1,158 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" 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:programlisting language="qml" its:translate="no">// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + +import QtQuick 1.0 + +/*! + \qmltype TabWidget + \inqmlmodule UIComponents + \brief A widget that places its children as tabs. + + A TabWidget places its children as tabs in a view. Selecting + a tab involves selecting the tab at the top. + + The TabWidget component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. + + \section1 Adding Tabs + + To add a tab, declare the tab as a child of the TabWidget. + + \code + TabWidget { + id: tabwidget + + Rectangle { + id: tab1 + color: &quot;red&quot; + //... omitted + } + Rectangle { + id: tab2 + color: &quot;blue&quot; + //... omitted + } + + } + \endcode + +*/ +Item { + id: tabWidget + + /*! + \internal + + Setting the default property to stack.children means any child items + of the TabWidget are actually added to the 'stack' item's children. + + See the \l{&quot;Property Binding in QML&quot;} + documentation for details on default properties. + + This is an implementation detail, not meant for public knowledge. Putting + the \internal command at the beginning will cause QDoc to not publish this + documentation in the public API page. + + Normally, a property alias needs to have a + &quot;\qmlproperty &lt;type&gt; &lt;propertyname&gt;&quot; to assign the alias a type. + + */ + default property alias content: stack.children + + /*! + The currently active tab in the TabWidget. + */ + property int current: 0 + + /*! + A sample \c{read-only} property. + A contrived property to demonstrate QDoc's ability to detect + read-only properties. + + The signature is: + \code + readonly property int sampleReadOnlyProperty: 0 + \endcode + + Note that the property must be initialized to a value. + + */ + readonly property int sampleReadOnlyProperty: 0 + + /*! + \internal + + This handler is an implementation + detail. The \c{\internal} command will prevent QDoc from publishing this + documentation on the public API. + */ + onCurrentChanged: setOpacities() + Component.onCompleted: setOpacities() + + /*! + \internal + + An internal function to set the opacity. + The \internal command will prevent QDoc from publishing this + documentation on the public API. + */ + function setOpacities() { + for (var i = 0; i &lt; stack.children.length; ++i) { + stack.children[i].opacity = (i == current ? 1 : 0) + } + } + + Row { + id: header + + Repeater { + model: stack.children.length + delegate: Rectangle { + width: tabWidget.width / stack.children.length; height: 36 + + Rectangle { + width: parent.width; height: 1 + anchors { bottom: parent.bottom; bottomMargin: 1 } + color: &quot;#acb2c2&quot; + } + BorderImage { + anchors { fill: parent; leftMargin: 2; topMargin: 5; rightMargin: 1 } + border { left: 7; right: 7 } + source: &quot;tab.png&quot; + visible: tabWidget.current == index + } + Text { + horizontalAlignment: Qt.AlignHCenter; verticalAlignment: Qt.AlignVCenter + anchors.fill: parent + text: stack.children[index].title + elide: Text.ElideRight + font.bold: tabWidget.current == index + } + MouseArea { + anchors.fill: parent + onClicked: tabWidget.current = index + } + } + } + } + + Item { + id: stack + width: tabWidget.width + anchors.top: header.bottom; anchors.bottom: tabWidget.bottom + } +} + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-demo-cpp.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-demo-cpp.xml new file mode 100644 index 000000000..e10690185 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-demo-cpp.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Demo</db:title> +<db:productname>Test</db:productname> +<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:programlisting language="cpp" its:translate="no">// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 + +bool isOverThousand(int n) +{ + if (n &gt; 1'000) + return true; + return false; +} + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-demo-pro.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-demo-pro.xml new file mode 100644 index 000000000..a51cb5a2e --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-demo-pro.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Demo</db:title> +<db:productname>Test</db:productname> +<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:programlisting language="cpp" its:translate="no">TEMPLATE = aux +message(&quot;Nothing to see here.&quot;) + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-dontxclude-cmakelists-txt.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-dontxclude-cmakelists-txt.xml new file mode 100644 index 000000000..4cfd84878 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-dontxclude-cmakelists-txt.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Demo</db:title> +<db:productname>Test</db:productname> +<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:programlisting language="cpp" its:translate="no">cmake_minimum_required(VERSION 3.16) +project (DONTXCLUDEDIRS_QDOCTEST) + +</db:programlisting> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-example.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-example.xml new file mode 100644 index 000000000..b81f636ba --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-demo-example.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Demo</db:title> +<db:productname>Test</db:productname> +<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:mediaobject> +<db:imageobject> +<db:imagedata fileref="images/leonardo-da-vinci.png"/> +</db:imageobject> +</db:mediaobject> +<db:programlisting language="cpp" its:translate="no"> if (n &gt; 1'000) + return true; +</db:programlisting> +<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="demos/demo/demo.cpp">demos/demo/demo.cpp</db:link></db:para></db:listitem> +<db:listitem> +<db:para><db:link xlink:href="demos/demo/demo.pro">demos/demo/demo.pro</db:link></db:para></db:listitem> +<db:listitem> +<db:para><db:link xlink:href="demos/demo/dontxclude/CMakeLists.txt">demos/demo/dontxclude/CMakeLists.txt</db:link></db:para></db:listitem> +</db:itemizedlist> +</db:section> +</db:section></db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-hidden-example.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-hidden-example.xml new file mode 100644 index 000000000..b3a1e7996 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-demos-hidden-example.xml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>Hidden Demo</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Tagged 'broken', does not appear in examples-manifest.xml.</db:para> +</db:abstract> +</db:info> +<db:para>Also missing an image, but that's OK as it's broken anyway.</db:para> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-empty-qmlmodule.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-empty-qmlmodule.xml new file mode 100644 index 000000000..f58917730 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-empty-qmlmodule.xml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">No QML Types Here</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A QML module with no member types.</db:para> +</db:abstract> +</db:info> +<db:anchor xml:id="details"/> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-nover-qmlmodule.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-nover-qmlmodule.xml new file mode 100644 index 000000000..091fe4358 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/test-nover-qmlmodule.xml @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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-doctest.xml" xlink:role="">DocTest</db:link></db:term> +<db:listitem> +<db:para>Shadows the type name in QDoc.Test module.</db:para> +</db:listitem> +</db:varlistentry> +<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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testcpp-module.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testcpp-module.xml new file mode 100644 index 000000000..d8e4647ac --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testcpp-module.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">QDoc Test C++ Classes</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</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="seenclass.xml" xlink:role="class">SeenClass</db:link></db:term> +<db:listitem> +<db:para>A public but undocumented class.</db:para> +</db:listitem> +</db:varlistentry> +<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 class in a namespace, derived from Test.</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:para>This module was introduced in version 5.15.</db:para> +<db:para>1.0</db:para> +<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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc-test.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc-test.xml new file mode 100644 index 000000000..bcb583839 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc-test.xml @@ -0,0 +1,376 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">Test Class</db:title> +<db:subtitle its:translate="no">TestQDoc::Test</db:subtitle> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A class in a namespace.</db:para> +<db:para>This class was introduced in Qt 1.1.</db:para> +<db:note> +<db:para>All functions in this class are <db:link xlink:href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</db:link> with the following exceptions:</db:para> +<db:para>These functions are not <db:link xlink:href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</db:link>:</db:para> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#someFunctionDefaultArg">someFunctionDefaultArg(int i, bool b) const</db:link></db:para> +</db:listitem> +</db:itemizedlist> +</db:note> +</db:abstract> +</db:info> +<db:variablelist its:translate="no"> +<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 1.1</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>In QML</db:term> +<db:listitem> +<db:para><db:link xlink:href="qml-qdoc-test-type.xml" xlink:role="">Type</db:link></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>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: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 its:translate="no">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 its:translate="no">[protected] void Test::overload()</db:title> +<db:bridgehead renderas="sect2" xml:id="overload-1" its:translate="no">[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 its:translate="no" role="parameter">b</db:code>.</db:para> +</db:section> +<db:section xml:id="Test"> +<db:title its:translate="no">Test::Test()</db:title> +<db:constructorsynopsis> +<db:methodname>Test</db:methodname> +<db:void/> +<db:synopsisinfo role="meta">constructor</db:synopsisinfo> +<db:synopsisinfo role="signature">Test()</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>The constructor is deleted.</db:para> +</db:section> +<db:section xml:id="funcPtr"> +<db:title its:translate="no">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 its:translate="no" role="parameter">b</db:code> and <db:code its:translate="no" role="parameter">s</db:code>.</db:para> +</db:section> +<db:section xml:id="inlineFunction"> +<db:title its:translate="no">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 its:translate="no">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 its:translate="no">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" its:translate="no">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 its:translate="no">[since Test 1.0] 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 its:translate="no" role="parameter">v</db:code>. Also returns the value of <db:code its:translate="no" role="parameter">v</db:code>.</db:para> +<db:para>This function was introduced in Test 1.0.</db:para> +</db:section> +<db:section xml:id="someFunctionDefaultArg"> +<db:title its:translate="no">[since 2.0] void Test::someFunctionDefaultArg(int <db:emphasis>i</db:emphasis>, bool <db:emphasis>b</db:emphasis> = false) const</db:title> +<db:methodsynopsis> +<db:modifier>const</db:modifier> +<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) const</db:synopsisinfo> +<db:synopsisinfo role="access">public</db:synopsisinfo> +<db:synopsisinfo role="status">active</db:synopsisinfo> +<db:synopsisinfo role="threadsafeness">non-reentrant</db:synopsisinfo> +</db:methodsynopsis> +<db:para>Function that takes a parameter <db:code its:translate="no" role="parameter">i</db:code> and <db:code its:translate="no" role="parameter">b</db:code>.</db:para> +<db:warning> +<db:para>This function is not <db:link xlink:href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</db:link>.</db:para> +</db:warning><db:para>This function was introduced in Qt 2.0.</db:para> +</db:section> +<db:section xml:id="virtualFun"> +<db:title its:translate="no">[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 its:translate="no">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:synopsisinfo role="meta">move-assign</db:synopsisinfo> +<db:synopsisinfo role="signature">TestQDoc::Test & operator=(TestQDoc::Test &&other)</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>The move assignment operator is deleted. <db:code its:translate="no" role="parameter">other</db:code> cannot be moved from.</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 its:translate="no">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 its:translate="no" role="parameter">lhs</db:code> and <db:code its:translate="no" 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 its:translate="no">[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 its:translate="no" 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 its:translate="no">[deprecated] TestQDoc::Test &Test::operator++()</db:title> +<db:bridgehead renderas="sect2" xml:id="operator--" its:translate="no">[deprecated] 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 its:translate="no">[deprecated] 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 its:translate="no">[deprecated in 6.0] 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 its:translate="no">[deprecated] 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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc-testderived.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc-testderived.xml new file mode 100644 index 000000000..c6272cc7d --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc-testderived.xml @@ -0,0 +1,308 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">TestDerived Class</db:title> +<db:subtitle its:translate="no">TestQDoc::TestDerived</db:subtitle> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A class in a namespace, derived from <db:link xlink:href="testqdoc-test.xml">Test</db:link>.</db:para> +<db:para>This class was introduced in Qt 2.0.</db:para> +</db:abstract> +</db:info> +<db:variablelist its:translate="no"> +<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>In QML</db:term> +<db:listitem> +<db:para><db:link xlink:href="qml-themodule-thetype.xml" xlink:role="">TheType</db:link></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 its:translate="no">[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 its:translate="no">[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="property-documentation"> +<db:title>Property Documentation</db:title> +<db:section xml:id="bindableProp-prop"> +<db:title its:translate="no">[bindable] bindableProp : QString</db:title> +<db:fieldsynopsis> +<db:modifier>(Qt property)</db:modifier> +<db:type>QString</db:type> +<db:varname>bindableProp</db:varname> +<db:synopsisinfo role="access">public</db:synopsisinfo> +<db:synopsisinfo role="status">active</db:synopsisinfo> +<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> +<db:synopsisinfo role="getter">bindableProp</db:synopsisinfo> +<db:synopsisinfo role="setter">setBindableProp</db:synopsisinfo> +<db:synopsisinfo role="notifier">bindablePropChanged</db:synopsisinfo> +</db:fieldsynopsis> +<db:para>This property supports <db:link xlink:href="https://wiki.qt.io/QProperty">QProperty</db:link> bindings.</db:para> +<db:para>Some property.</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-testderived.xml#someProp-prop">someProp</db:link></db:member> +</db:simplelist> +</db:para> +</db:section> +</db:section> +<db:section xml:id="boolProp-prop"> +<db:title its:translate="no">boolProp : bool</db:title> +<db:fieldsynopsis> +<db:modifier>(Qt property)</db:modifier> +<db:type>bool</db:type> +<db:varname>boolProp</db:varname> +<db:synopsisinfo role="access">public</db:synopsisinfo> +<db:synopsisinfo role="status">active</db:synopsisinfo> +<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> +<db:synopsisinfo role="getter">boolProp</db:synopsisinfo> +<db:synopsisinfo role="setter">setBoolProp</db:synopsisinfo> +<db:synopsisinfo role="resetter">resetBoolProp</db:synopsisinfo> +<db:synopsisinfo role="notifier">boolPropChanged</db:synopsisinfo> +</db:fieldsynopsis> +<db:para>A boolean property.</db:para> +<db:para> +<db:emphasis role="bold">Access functions: +</db:emphasis> +</db:para> +<db:itemizedlist its:translate="no"> +<db:listitem> +<db:para><db:type>bool</db:type> <db:emphasis role="bold"><db:link xlink:href="">boolProp</db:link></db:emphasis>()</db:para> +</db:listitem> +<db:listitem> +<db:para><db:type>void</db:type> <db:emphasis role="bold"><db:link xlink:href="">setBoolProp</db:link></db:emphasis>(<db:type>bool</db:type> <db:emphasis>b</db:emphasis>)</db:para> +</db:listitem> +<db:listitem> +<db:para><db:type>void</db:type> <db:emphasis role="bold"><db:link xlink:href="">resetBoolProp</db:link></db:emphasis>()</db:para> +</db:listitem> +</db:itemizedlist> +<db:para> +<db:emphasis role="bold">Notifier signal: +</db:emphasis> +</db:para> +<db:itemizedlist its:translate="no"> +<db:listitem> +<db:para><db:type>void</db:type> <db:emphasis role="bold"><db:link xlink:href="">boolPropChanged</db:link></db:emphasis>()</db:para> +</db:listitem> +</db:itemizedlist> +</db:section> +<db:section xml:id="intProp-prop"> +<db:title its:translate="no">[read-only] intProp : int* const</db:title> +<db:fieldsynopsis> +<db:modifier>(Qt property)</db:modifier> +<db:type>int*</db:type> +<db:varname>intProp</db:varname> +<db:synopsisinfo role="access">public</db:synopsisinfo> +<db:synopsisinfo role="status">active</db:synopsisinfo> +<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> +<db:synopsisinfo role="getter">getInt</db:synopsisinfo> +</db:fieldsynopsis> +<db:para>An integer property.</db:para> +<db:para> +<db:emphasis role="bold">Access functions: +</db:emphasis> +</db:para> +<db:itemizedlist its:translate="no"> +<db:listitem> +<db:para><db:type>int</db:type> *<db:emphasis role="bold"><db:link xlink:href="">getInt</db:link></db:emphasis>()</db:para> +</db:listitem> +</db:itemizedlist> +</db:section> +<db:section xml:id="name-prop"> +<db:title its:translate="no">[read-only] name : const QString*</db:title> +<db:fieldsynopsis> +<db:modifier>(Qt property)</db:modifier> +<db:type>const QString*</db:type> +<db:varname>name</db:varname> +<db:synopsisinfo role="access">public</db:synopsisinfo> +<db:synopsisinfo role="status">active</db:synopsisinfo> +<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> +<db:synopsisinfo role="getter">name</db:synopsisinfo> +</db:fieldsynopsis> +<db:para>This property holds a name.</db:para> +<db:para> +<db:emphasis role="bold">Access functions: +</db:emphasis> +</db:para> +<db:itemizedlist its:translate="no"> +<db:listitem> +<db:para>const <db:type>QString</db:type> *<db:emphasis role="bold"><db:link xlink:href="">name</db:link></db:emphasis>() const</db:para> +</db:listitem> +</db:itemizedlist> +</db:section> +<db:section xml:id="someProp-prop"> +<db:title its:translate="no">[bindable read-only] someProp : QString</db:title> +<db:fieldsynopsis> +<db:modifier>(Qt property)</db:modifier> +<db:type>QString</db:type> +<db:varname>someProp</db:varname> +<db:synopsisinfo role="access">public</db:synopsisinfo> +<db:synopsisinfo role="status">active</db:synopsisinfo> +<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo> +<db:synopsisinfo role="getter">someProp</db:synopsisinfo> +</db:fieldsynopsis> +<db:para>This property supports <db:link xlink:href="https://wiki.qt.io/QProperty">QProperty</db:link> bindings.</db:para> +<db:para>Another property.</db:para> +</db:section> +</db:section> +<db:section xml:id="member-function-documentation"> +<db:title>Member Function Documentation</db:title> +<db:section xml:id="emitSomething"> +<db:title its:translate="no">[private signal] void TestDerived::emitSomething()</db:title> +<db:methodsynopsis> +<db:void/> +<db:methodname>emitSomething</db:methodname> +<db:void/> +<db:synopsisinfo role="meta">signal</db:synopsisinfo> +<db:synopsisinfo role="signature">void emitSomething()</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>Emitted when things happen.</db:para> +<db:note> +<db:para>This is a private signal. It can be used in signal connections but cannot be emitted by the user.</db:para></db:note> +</db:section> +<db:section xml:id="id"> +<db:title its:translate="no">[override virtual] int TestDerived::id()</db:title> +<db:methodsynopsis> +<db:modifier>virtual</db:modifier> +<db:type>int</db:type> +<db:methodname>id</db:methodname> +<db:void/> +<db:modifier>override</db:modifier> +<db:synopsisinfo role="meta">plain</db:synopsisinfo> +<db:synopsisinfo role="signature">int id() 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:section> +<db:section xml:id="invokeMe"> +<db:title its:translate="no">[invokable] void TestDerived::invokeMe() const</db:title> +<db:methodsynopsis> +<db:modifier>const</db:modifier> +<db:void/> +<db:methodname>invokeMe</db:methodname> +<db:void/> +<db:synopsisinfo role="meta">plain</db:synopsisinfo> +<db:synopsisinfo role="signature">void invokeMe() const</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>Something invokable.</db:para> +<db:note> +<db:para>This function can be invoked via the meta-object system and from QML. See <db:link xlink:href="">Q_INVOKABLE</db:link>.</db:para> +</db:note> +</db:section> +<db:section xml:id="someValue"> +<db:title its:translate="no">TestQDoc::TestDerived::NotTypedef TestDerived::someValue()</db:title> +<db:methodsynopsis> +<db:type>TestQDoc::TestDerived::NotTypedef</db:type> +<db:methodname>someValue</db:methodname> +<db:void/> +<db:synopsisinfo role="meta">plain</db:synopsisinfo> +<db:synopsisinfo role="signature">TestQDoc::TestDerived::NotTypedef someValue()</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 value using an aliases type.</db:para> +</db:section> +<db:section xml:id="virtualFun"> +<db:title its:translate="no">[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 its:translate="no">[static, deprecated] 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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc.xml new file mode 100644 index 000000000..2322302a0 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">TestQDoc Namespace</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</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 its:translate="no"> +<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 class in a namespace, derived from <db:link xlink:href="testqdoc-test.xml">Test</db:link>.</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 its:translate="no">[since Test 0.9] 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:para>This macro was introduced in Test 0.9.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/themodule-qmlmodule.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/themodule-qmlmodule.xml new file mode 100644 index 000000000..d3c4ed894 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/themodule-qmlmodule.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no"></db:title> +<db:productname>Test</db:productname> +<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:anchor xml:id="details"/> +<db:itemizedlist role="members"> +<db:listitem> +<db:para><db:link xlink:href="qml-themodule-thetype.xml" xlink:role="">TheType</db:link></db:para> +</db:listitem> +</db:itemizedlist> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/uicomponents-qmlmodule.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/uicomponents-qmlmodule.xml new file mode 100644 index 000000000..80e5b0cdc --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/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" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">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/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/autolinking.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/autolinking.html new file mode 100644 index 000000000..ead0896fe --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/autolinking.html @@ -0,0 +1,36 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- classlists.qdoc --> + <title>Autolinking | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#testqdoc">TestQDoc</a></li> +<li class="level1"><a href="#someprop">someProp</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Autolinking</h1> +<!-- $$$autolinking.html-description --> +<div class="descr" id="details"> +<h2 id="testqdoc">TestQDoc</h2> +<p>The string <a href="testqdoc.html" translate="no">TestQDoc</a> links to the C++ namespace unless linking explicitly, <a href="autolinking.html#testqdoc">like this</a>, or <a href="testqdoc.html" translate="no">this</a>. Also,</p> +<p>Autolinks:</p> +<ul> +<li><a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></li> +</ul> +<p>Explicit links:</p> +<ul> +<li><a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></li> +<li><a href="obsolete-classes.html#testqdoc">Obsolete Classes#TestQDoc</a></li> +</ul> +<h2 id="someprop">someProp</h2> +</div> +<!-- @@@autolinking.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/classes.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/classes.html new file mode 100644 index 000000000..6a8df3334 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/classes.html @@ -0,0 +1,21 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- unseenclass.qdoc --> + <title>Classes | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Classes</h1> +<!-- $$$classes.html-description --> +<div class="descr" id="details"> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="seenclass.html">SeenClass</a></p></td><td class="tblDescr"><p>A public but undocumented class</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-test.html">TestQDoc::Test</a></p></td><td class="tblDescr"><p>A class in a namespace</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p></td><td class="tblDescr"><p>A class in a namespace, derived from Test</p></td></tr> +</table></div> +</div> +<!-- @@@classes.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/cpptypes.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/cpptypes.html new file mode 100644 index 000000000..3bd7789ff --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/cpptypes.html @@ -0,0 +1,25 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- classlists.qdoc --> + <title>Test C++ Types | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Test C++ Types</h1> +<!-- $$$cpptypes-description --> +<div class="descr" id="details"> +<ul> +<li translate="no"><a href="testqdoc-test.html">TestQDoc::Test</a></li> +<li translate="no"><a href="testqdoc-test.html#QDOCTEST_MACRO2">TestQDoc::Test::QDOCTEST_MACRO2</a></li> +<li translate="no"><a href="testqdoc-test.html#operator-eq">TestQDoc::Test::operator=()</a></li> +<li translate="no"><a href="testqdoc-test.html#someFunctionDefaultArg">TestQDoc::Test::someFunctionDefaultArg()</a></li> +</ul> +</div> +<!-- @@@cpptypes --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-test.html">TestQDoc::Test</a></p></td><td class="tblDescr"><p>A class in a namespace</p></td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/crossmoduleref.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/crossmoduleref.html new file mode 100644 index 000000000..f681dbd69 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/crossmoduleref.html @@ -0,0 +1,47 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="Namespace that has documented functions in multiple modules."> + <title>CrossModuleRef Namespace | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#functions">Functions</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">CrossModuleRef Namespace</h1> +<!-- $$$CrossModuleRef-brief --> +<p>Namespace that has documented functions in multiple modules. <a href="#details">More...</a></p> +<!-- @@@CrossModuleRef --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <CrossModuleRef></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 3.0</td></tr> +</table></div> +<h2 id="functions">Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="crossmoduleref.html#documentMe" translate="no">documentMe</a></b>()</td></tr> +</table></div> +<!-- $$$CrossModuleRef-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@CrossModuleRef --> +<div class="func"> +<h2>Function Documentation</h2> +<!-- $$$documentMe[overload1]$$$documentMe --> +<h3 class="fn" translate="no" id="documentMe"><span class="type">void</span> CrossModuleRef::<span class="name">documentMe</span>()</h3> +<p>Document me!</p> +<!-- @@@documentMe --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/images/leonardo-da-vinci.png b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/images/leonardo-da-vinci.png Binary files differnew file mode 100644 index 000000000..854acb4ca --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/images/leonardo-da-vinci.png diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/obsolete-classes.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/obsolete-classes.html new file mode 100644 index 000000000..575b6e45c --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/obsolete-classes.html @@ -0,0 +1,32 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- classlists.qdoc --> + <title>Obsolete Classes | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#classes-with-obsolete-members">Classes with obsolete members</a></li> +<li class="level2"><a href="#testqdoc">TestQDoc</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Obsolete Classes</h1> +<!-- $$$obsolete-classes.html-description --> +<div class="descr" id="details"> +<h2 id="classes-with-obsolete-members">Classes with obsolete members</h2> +<div class="flowListDiv" translate="no"> +<dl class="flowList odd"><dt class="alphaChar"><b>T</b></dt> +<dd><a href="testqdoc-test-obsolete.html">Test</a> (<a href="testqdoc.html">TestQDoc</a>)</dd> +<dd><a href="testqdoc-testderived-obsolete.html">TestDerived</a> (<a href="testqdoc.html">TestQDoc</a>)</dd> +</dl> +</div> +<h3 id="testqdoc">TestQDoc</h3> +</div> +<!-- @@@obsolete-classes.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qdoc-test-qmlmodule.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qdoc-test-qmlmodule.html new file mode 100644 index 000000000..6be64618b --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qdoc-test-qmlmodule.html @@ -0,0 +1,27 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="QML Types for the Test module."> + <title>QDoc.Test QML Module | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">QDoc.Test QML Module</h1> +<p><b>This module is under development and is subject to change.</b></p> +<p>This module was introduced in Qt 1.1.</p> +<!-- $$$QDoc.Test-description --> +<div class="descr" id="details"> +</div> +<!-- @@@QDoc.Test --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-abstractparent.html">AbstractParent</a></p></td><td class="tblDescr"><p>Abstract base QML type</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-child.html">Child</a></p></td><td class="tblDescr"><p>A Child inheriting its parent</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-doctest.html">DocTest</a></p></td><td class="tblDescr"><p>Represents a doc test case</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-type.html">Type</a></p></td><td class="tblDescr"><p>A QML type documented in a .cpp file</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-yetanotherchild.html">YetAnotherChild</a></p></td><td class="tblDescr"><p>A type inheriting from internal abstract parent</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qml-int.html">int</a></p></td><td class="tblDescr"><p>An integer value type</p></td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-int.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-int.html new file mode 100644 index 000000000..63ea49e7d --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-int.html @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="An integer value type."> + <title>int QML Value Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>int</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#methods">Methods</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">int QML Value Type</h1> +<!-- $$$int-brief --> +<p>An integer value type. <a href="#details">More...</a></p> +<!-- @@@int --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr></table></div><h2 id="methods">Methods</h2> +<ul> +<li class="fn" translate="no">int <b><a href="qml-int.html#abs-method" translate="no">abs</a></b>()</li> +</ul> +<!-- $$$int-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@int --> +<h2>Method Documentation</h2> +<!-- $$$abs[overload1]$$$abs --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="abs-method"> +<td class="tblQmlFuncNode"><p> +<span class="type"><a href="qml-int.html" translate="no">int</a></span> <span class="name">abs</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Returns the absolute value of this integer.</p> +</div></div><!-- @@@abs --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-abstractparent-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-abstractparent-members.html new file mode 100644 index 000000000..af49329a3 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-abstractparent-members.html @@ -0,0 +1,23 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="Abstract base QML type."> + <title>List of All Members for AbstractParent | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>AbstractParent</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for AbstractParent</h1> +<p>This is the complete list of members for <a href="qml-qdoc-test-abstractparent.html">AbstractParent</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-abstractparent.html#children-prop" translate="no">children</a></b> : list<Child> [default]</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-abstractparent.html#name-prop" translate="no">name</a></b> : string</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-abstractparent.html#name-method" translate="no">name</a></b>()</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-abstractparent.html#name-method-1" translate="no">name</a></b>(Child <i>child</i>, <i>name</i>)</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-abstractparent.html#rear-method" translate="no">rear</a></b>(Child <i>child</i>, var <i>method</i>)</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-abstractparent.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-abstractparent.html new file mode 100644 index 000000000..8fe88bee7 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-abstractparent.html @@ -0,0 +1,98 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="Abstract base QML type."> + <title>AbstractParent QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>AbstractParent</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#methods">Methods</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">AbstractParent QML Type</h1> +<!-- $$$AbstractParent-brief --> +<p>Abstract base QML type. <a href="#details">More...</a></p> +<!-- @@@AbstractParent --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qdoc-test-child.html" translate="no">Child</a></p> +</td></tr></table></div><ul> +<li><a href="qml-qdoc-test-abstractparent-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-abstractparent.html#children-prop" translate="no">children</a></b> : list<Child></li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-abstractparent.html#name-prop" translate="no">name</a></b> : string</li> +</ul> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-abstractparent.html#name-method" translate="no">name</a></b>()</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-abstractparent.html#name-method-1" translate="no">name</a></b>(Child <i>child</i>, <i>name</i>)</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-abstractparent.html#rear-method" translate="no">rear</a></b>(Child <i>child</i>, var <i>method</i>)</li> +</ul> +<!-- $$$AbstractParent-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@AbstractParent --> +<h2>Property Documentation</h2> +<!-- $$$children --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="children-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html" translate="no">Child</a></span>> <code class="details extra" translate="no">[default]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Children of the type.</p> +</div></div><!-- @@@children --> +<br/> +<!-- $$$name --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">name</span> : <span class="type">string</span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name of this parent.</p> +</div></div><!-- @@@name --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$name[overload1]$$$name --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-method"> +<td class="tblQmlFuncNode"><p> +<span class="type">void</span> <span class="name">name</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name all children with random names.</p> +</div></div><!-- @@@name --> +<br/> +<!-- $$$name$$$nameChild --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-method-1"> +<td class="tblQmlFuncNode"><p> +<span class="type">void</span> <span class="name">name</span>(<span class="type"><a href="qml-qdoc-test-child.html" translate="no">Child</a></span> <i>child</i>, <i>name</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name a <i translate="no">child</i> using <i translate="no">name</i>.</p> +</div></div><!-- @@@name --> +<br/> +<!-- $$$rear[overload1]$$$rearChildvar --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="rear-method"> +<td class="tblQmlFuncNode"><p> +<span class="type">void</span> <span class="name">rear</span>(<span class="type"><a href="qml-qdoc-test-child.html" translate="no">Child</a></span> <i>child</i>, <span class="type">var</span> <i>method</i> = Strict)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Do some abstract parenting on <i translate="no">child</i> using a specific <i translate="no">method</i>.</p> +</div></div><!-- @@@rear --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-child-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-child-members.html new file mode 100644 index 000000000..c9a9b0a5c --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-child-members.html @@ -0,0 +1,23 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="A Child inheriting its parent."> + <title>List of All Members for Child | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>Child</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for Child</h1> +<p>This is the complete list of members for <a href="qml-qdoc-test-child.html">Child</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-child.html#children-prop" translate="no">children</a></b> : list<Child> [default]</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-child.html#name-prop" translate="no">name</a></b> : string</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-child.html#name-method" translate="no">name</a></b>(Child <i>child</i>, <i>name</i>)</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-child.html#name-method" translate="no">name</a></b>()</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-child.html#rear-method" translate="no">rear</a></b>(Child <i>child</i>, var <i>method</i>)</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-child.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-child.html new file mode 100644 index 000000000..578c2f829 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-child.html @@ -0,0 +1,98 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="A Child inheriting its parent."> + <title>Child QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>Child</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#methods">Methods</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Child QML Type</h1> +<!-- $$$Child-brief --> +<p>A Child inheriting its parent. <a href="#details">More...</a></p> +<!-- @@@Child --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qdoc-test-abstractparent.html" translate="no">AbstractParent</a></p> +</td></tr></table></div><ul> +<li><a href="qml-qdoc-test-child-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-child.html#children-prop" translate="no">children</a></b> : list<Child></li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-child.html#name-prop" translate="no">name</a></b> : string</li> +</ul> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-child.html#name-method" translate="no">name</a></b>(Child <i>child</i>, <i>name</i>)</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-child.html#name-method" translate="no">name</a></b>()</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-child.html#rear-method" translate="no">rear</a></b>(Child <i>child</i>, var <i>method</i>)</li> +</ul> +<!-- $$$Child-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@Child --> +<h2>Property Documentation</h2> +<!-- $$$children --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="children-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html" translate="no">Child</a></span>> <code class="details extra" translate="no">[default]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Children of the type.</p> +</div></div><!-- @@@children --> +<br/> +<!-- $$$name --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">name</span> : <span class="type">string</span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name of this child.</p> +</div></div><!-- @@@name --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$name[overload1]$$$nameChild --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-method"> +<td class="tblQmlFuncNode"><p> +<span class="type">void</span> <span class="name">name</span>(<span class="type"><a href="qml-qdoc-test-child.html" translate="no">Child</a></span> <i>child</i>, <i>name</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name a <i translate="no">child</i> of this child using <i translate="no">name</i>.</p> +</div></div><!-- @@@name --> +<br/> +<!-- $$$name[overload1]$$$name --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-method"> +<td class="tblQmlFuncNode"><p> +<span class="type">void</span> <span class="name">name</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name all children with random names.</p> +</div></div><!-- @@@name --> +<br/> +<!-- $$$rear[overload1]$$$rearChildvar --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="rear-method"> +<td class="tblQmlFuncNode"><p> +<span class="type">void</span> <span class="name">rear</span>(<span class="type"><a href="qml-qdoc-test-child.html" translate="no">Child</a></span> <i>child</i>, <span class="type">var</span> <i>method</i> = Strict)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Do some abstract parenting on <i translate="no">child</i> using a specific <i translate="no">method</i>.</p> +</div></div><!-- @@@rear --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-doctest-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-doctest-members.html new file mode 100644 index 000000000..706b65b20 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-doctest-members.html @@ -0,0 +1,25 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- DocTest.qml --> + <meta name="description" content="Represents a doc test case."> + <title>List of All Members for DocTest | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>DocTest</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for DocTest</h1> +<p>This is the complete list of members for <a href="qml-qdoc-test-doctest.html">DocTest</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#active-prop" translate="no">active</a></b> : bool</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#name-prop" translate="no">name</a></b> : string</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#completed-signal" translate="no">completed</a></b>()</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#fail-method" translate="no">fail</a></b>(<i>message</i>) <code class="summary extra" translate="no">(since QDoc.Test 1.0)</code></li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#fail_hard-method" translate="no">fail_hard</a></b>(<i>msg</i>, <i>option</i>)</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#foo-signal" translate="no">foo</a></b>(var <i>bar</i>)</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#itsHappening-signal" translate="no">itsHappening</a></b>(bool <i>really</i>)</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-doctest.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-doctest.html new file mode 100644 index 000000000..37174fb59 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-doctest.html @@ -0,0 +1,139 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- DocTest.qml --> + <meta name="description" content="Represents a doc test case."> + <title>DocTest QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>DocTest</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#signals">Signals</a></li> +<li class="level1"><a href="#methods">Methods</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#introduction">Introduction</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">DocTest QML Type</h1> +<!-- $$$DocTest-brief --> +<p>Represents a doc test case. <a href="#details">More...</a></p> +<!-- @@@DocTest --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> QDoc.Test 0.9</td></tr></table></div><ul> +<li><a href="qml-qdoc-test-doctest-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#active-prop" translate="no">active</a></b> : bool</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#name-prop" translate="no">name</a></b> : string</li> +</ul> +<h2 id="signals">Signals</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#completed-signal" translate="no">completed</a></b>()</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#foo-signal" translate="no">foo</a></b>(var <i>bar</i>)</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#itsHappening-signal" translate="no">itsHappening</a></b>(bool <i>really</i>)</li> +</ul> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#fail-method" translate="no">fail</a></b>(<i>message</i>) <code class="summary extra" translate="no">(since QDoc.Test 1.0)</code></li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-doctest.html#fail_hard-method" translate="no">fail_hard</a></b>(<i>msg</i>, <i>option</i>)</li> +</ul> +<!-- $$$DocTest-description --> +<h2 id="details">Detailed Description</h2> +<h2 id="introduction">Introduction</h2> +<p>A documentation test case, itself documented inline in DocTest.qml.</p> +<!-- @@@DocTest --> +<h2>Property Documentation</h2> +<!-- $$$active --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="active-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">active</span> : <span class="type">bool</span> <code class="details extra" translate="no">[default: true]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Whether the test is active.</p> +<p><b>See also </b><a href="qml-qdoc-test-doctest.html#name-prop" translate="no">name</a>.</p> +</div></div><!-- @@@active --> +<br/> +<!-- $$$name --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">name</span> : <span class="type">string</span> <code class="details extra" translate="no">[required]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name of the test.</p> +<pre class="qml" translate="no"><span class="type"><a href="qml-test-nover-doctest.html" translate="no">DocTest</a></span> { + <span class="name">name</span>: <span class="string">"test"</span> + <span class="comment">// ...</span> +}</pre> +</div></div><!-- @@@name --> +<br/> +<h2>Signal Documentation</h2> +<!-- $$$completed[overload1]$$$completed --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="completed-signal"> +<td class="tblQmlFuncNode"><p> +<span class="name">completed</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><div class="admonition note"><p><b>Note: </b>The corresponding handler is <code translate="no">onCompleted</code>.</p> +</div></div></div><!-- @@@completed --> +<br/> +<!-- $$$foo[overload1]$$$foovar --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="foo-signal"> +<td class="tblQmlFuncNode"><p> +<span class="name">foo</span>(<span class="type">var</span> <i>bar</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Signal with parameter <i translate="no">bar</i>.</p> +<div class="admonition note"><p><b>Note: </b>The corresponding handler is <code translate="no">onFoo</code>.</p> +</div></div></div><!-- @@@foo --> +<br/> +<!-- $$$itsHappening[overload1]$$$itsHappeningbool --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="itsHappening-signal"> +<td class="tblQmlFuncNode"><p> +<span class="name">itsHappening</span>(<span class="type">bool</span> <i>really</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Signals that something is <i translate="no">really</i> happening.</p> +<div class="admonition note"><p><b>Note: </b>The corresponding handler is <code translate="no">onItsHappening</code>.</p> +</div></div></div><!-- @@@itsHappening --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$fail[overload1]$$$fail --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="fail-method"> +<td class="tblQmlFuncNode"><p> +<code class="details extra" translate="no">[since QDoc.Test 1.0]</code> <span class="name">fail</span>(<i>message</i> = "oops")</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Fails the current test case, with the optional <i translate="no">message</i>.</p> +<p>This method was introduced in QDoc.Test 1.0.</p> +</div></div><!-- @@@fail --> +<br/> +<!-- $$$fail_hard[overload1]$$$fail_hard --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="fail_hard-method"> +<td class="tblQmlFuncNode"><p> +<span class="name">fail_hard</span>(<i>msg</i> = "facepalm", <i>option</i> = 123)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Fails the current test case, hard.</p> +<ul> +<li>Prints out <i translate="no">msg</i>.</li> +<li>Accepts a random <i translate="no">option</i>.</li> +</ul> +</div></div><!-- @@@fail_hard --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-oldtype-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-oldtype-members.html new file mode 100644 index 000000000..6527f5a6c --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-oldtype-members.html @@ -0,0 +1,16 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="Deprecated old type."> + <title>List of All Members for OldType | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>OldType</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for OldType</h1> +<p>This is the complete list of members for <a href="qml-qdoc-test-oldtype.html" class="obsolete">OldType</a>, including inherited members.</p> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-oldtype.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-oldtype.html new file mode 100644 index 000000000..4fe99b259 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-oldtype.html @@ -0,0 +1,33 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="Deprecated old type."> + <title>OldType QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>OldType</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">OldType QML Type</h1> +<!-- $$$OldType-brief --> +<p>Deprecated old type. <a href="#details">More...</a></p> +<!-- @@@OldType --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Status:</td><td class="memItemRight bottomAlign"> Deprecated since 1.0<span class="status deprecated"></span></td></tr></table></div><p><b>This type is deprecated since QDoc.Test 1.0. We strongly advise against using it in new code.</b></p> +<ul> +<li><a href="qml-qdoc-test-oldtype-members.html">List of all members, including inherited members</a></li> +</ul> +<!-- $$$OldType-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@OldType --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type-members.html new file mode 100644 index 000000000..eb3180a88 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type-members.html @@ -0,0 +1,37 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="A QML type documented in a .cpp file."> + <title>List of All Members for Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>Type</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for Type</h1> +<p>This is the complete list of members for <a href="qml-qdoc-test-type.html">Type</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#fifth-prop" translate="no">fifth</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#fourth-prop" translate="no">fourth</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group-prop" translate="no">group</a></b><ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group.first-prop" translate="no">group.first</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group.second-prop" translate="no">group.second</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group.third-prop" translate="no">group.third</a></b> : int</li> +</ul> +</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#id-prop" translate="no">id</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#name-prop" translate="no">name</a></b> : string</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#type-attached-prop" translate="no">type</a></b> : enumeration [attached]</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#completed-signal" translate="no">completed</a></b>(int <i>status</i>)</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#configured-signal" translate="no">configured</a></b>() [attached]</li> +<li class="fn" translate="no">Type <b><a href="qml-qdoc-test-type.html#copy-method" translate="no">copy</a></b>(<i>a</i>)</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type-obsolete.html#deprecatedMethod-method" translate="no">deprecatedMethod</a></b>() <code class="summary extra" translate="no">(deprecated in 6.2)</code></li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#disable-method" translate="no">disable</a></b>()</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#enable-method" translate="no">enable</a></b>()</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#futureDeprecated-method" translate="no">futureDeprecated</a></b>() <code class="summary extra" translate="no">(until 6.3)</code></li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group.created-signal" translate="no">group.created</a></b>()</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type-obsolete.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type-obsolete.html new file mode 100644 index 000000000..acd56759a --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type-obsolete.html @@ -0,0 +1,33 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="A QML type documented in a .cpp file."> + <title>Obsolete Members for Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>Type</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Obsolete Members for Type</h1> +<p><b>The following members of QML type <a href="qml-qdoc-test-type.html">Type</a> are deprecated.</b> They are provided to keep old source code working. We strongly advise against using them in new code.</p> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type-obsolete.html#deprecatedMethod-method" translate="no">deprecatedMethod</a></b>() <code class="summary extra" translate="no">(deprecated in 6.2)</code></li> +</ul> +<h2>Method Documentation</h2> +<!-- $$$deprecatedMethod[overload1]$$$deprecatedMethod --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="deprecatedMethod-method"> +<td class="tblQmlFuncNode"><p> +<code class="details extra" translate="no">[deprecated in 6.2]</code> <span class="name">deprecatedMethod</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>This method is deprecated since QDoc.Test 6.2. We strongly advise against using it in new code.</p> +<p>This method has no replacement.</p> +<p>This is a method that should include information about being deprecated and that it has been so since 6.2 in its docs.</p> +</div></div><!-- @@@deprecatedMethod --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type.html new file mode 100644 index 000000000..7fb53266d --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-type.html @@ -0,0 +1,209 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="A QML type documented in a .cpp file."> + <title>Type QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>Type</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#attached-properties">Attached Properties</a></li> +<li class="level1"><a href="#signals">Signals</a></li> +<li class="level1"><a href="#attached-signals">Attached Signals</a></li> +<li class="level1"><a href="#methods">Methods</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Type QML Type</h1> +<!-- $$$Type-brief --> +<p>A QML type documented in a .cpp file. <a href="#details">More...</a></p> +<!-- @@@Type --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> In C++:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-test.html" translate="no">Test</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Status:</td><td class="memItemRight bottomAlign"> <Work In Progress><span class="status work-in-progress"></span></td></tr></table></div><ul> +<li><a href="qml-qdoc-test-type-members.html">List of all members, including inherited members</a></li> +<li><a href="qml-qdoc-test-type-obsolete.html">Deprecated members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#fifth-prop" translate="no">fifth</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#fourth-prop" translate="no">fourth</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group-prop" translate="no">group</a></b><ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group.first-prop" translate="no">group.first</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group.second-prop" translate="no">group.second</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group.third-prop" translate="no">group.third</a></b> : int</li> +</ul> +</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#id-prop" translate="no">id</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#name-prop" translate="no">name</a></b> : string</li> +</ul> +<h2 id="attached-properties">Attached Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#type-attached-prop" translate="no">type</a></b> : enumeration</li> +</ul> +<h2 id="signals">Signals</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#completed-signal" translate="no">completed</a></b>(int <i>status</i>)</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#group.created-signal" translate="no">group.created</a></b>()</li> +</ul> +<h2 id="attached-signals">Attached Signals</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#configured-signal" translate="no">configured</a></b>()</li> +</ul> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn" translate="no">Type <b><a href="qml-qdoc-test-type.html#copy-method" translate="no">copy</a></b>(<i>a</i>)</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#disable-method" translate="no">disable</a></b>()</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#enable-method" translate="no">enable</a></b>()</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-type.html#futureDeprecated-method" translate="no">futureDeprecated</a></b>() <code class="summary extra" translate="no">(until 6.3)</code></li> +</ul> +<!-- $$$Type-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@Type --> +<h2>Property Documentation</h2> +<!-- $$$ --> +<div class="qmlitem"><div class="fngroup"> +<div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="fifth-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">fifth</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="fourth-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">fourth</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +</table></div></div> +</div><div class="qmldoc"><p>A group of properties sharing a documentation comment.</p> +</div></div><!-- @@@ --> +<br/> +<!-- $$$group --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="even" id="group-prop"><th class="centerAlign"><p><b>group group</b></p></th></tr> +<tr valign="top" class="odd" id="group.first-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.first</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="group.second-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.second</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="group.third-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.third</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>A property group.</p> +</div></div><!-- @@@group --> +<br/> +<!-- $$$id --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="id-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">id</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span> <code class="details extra" translate="no">[read-only]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>A read-only property.</p> +</div></div><!-- @@@id --> +<br/> +<!-- $$$name --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">name</span> : <span class="type">string</span> <code class="details extra" translate="no">[required]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name of the Test.</p> +</div></div><!-- @@@name --> +<br/> +<h2>Attached Property Documentation</h2> +<!-- $$$type --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="type-attached-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">Type.type</span> : <span class="type">enumeration</span> <code class="details extra" translate="no">[default: Type.NoType]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> +<tr><td class="topAlign"><code translate="no">Type.NoType</code></td><td class="topAlign">Nothing</td></tr> +<tr><td class="topAlign"><code translate="no">Type.SomeType</code></td><td class="topAlign">Something</td></tr> +</table></div> +</div></div><!-- @@@type --> +<br/> +<h2>Signal Documentation</h2> +<!-- $$$completed[overload1]$$$completedint --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="completed-signal"> +<td class="tblQmlFuncNode"><p> +<span class="name">completed</span>(<span class="type"><a href="qml-int.html" translate="no">int</a></span> <i>status</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>This signal is emitted when the operation completed with <i translate="no">status</i>.</p> +<div class="admonition note"><p><b>Note: </b>The corresponding handler is <code translate="no">onCompleted</code>.</p> +</div></div></div><!-- @@@completed --> +<br/> +<!-- $$$group.created[overload1]$$$group.created --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="group.created-signal"> +<td class="tblQmlFuncNode"><p> +<span class="name">group.created</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>This signal is prefixed with <i>group</i>.</p> +<div class="admonition note"><p><b>Note: </b>The corresponding handler is <code translate="no">group.onCreated</code>.</p> +</div></div></div><!-- @@@group.created --> +<br/> +<h2>Attached Signal Documentation</h2> +<!-- $$$configured[overload1]$$$configured --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="configured-signal"> +<td class="tblQmlFuncNode"><p> +<span class="name">configured</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>This attached signal is emitted when the type was configured.</p> +<div class="admonition note"><p><b>Note: </b>The corresponding handler is <code translate="no">onConfigured</code>.</p> +</div></div></div><!-- @@@configured --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$ --> +<div class="qmlitem"><div class="fngroup"> +<div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="disable-method"> +<td class="tblQmlFuncNode"><p> +<span class="name">disable</span>()</p></td></tr> +<tr valign="top" class="odd" id="enable-method"> +<td class="tblQmlFuncNode"><p> +<span class="name">enable</span>()</p></td></tr> +</table></div></div> +</div><div class="qmldoc"><p>Enables or disables this type.</p> +</div></div><!-- @@@ --> +<br/> +<!-- $$$copy[overload1]$$$copy --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="copy-method"> +<td class="tblQmlFuncNode"><p> +<span class="type"><a href="qml-qdoc-test-type.html" translate="no">Type</a></span> <span class="name">copy</span>(<i>a</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Returns another Type based on <i translate="no">a</i>.</p> +</div></div><!-- @@@copy --> +<br/> +<!-- $$$futureDeprecated[overload1]$$$futureDeprecated --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="futureDeprecated-method"> +<td class="tblQmlFuncNode"><p> +<code class="details extra" translate="no">[until 6.3]</code> <span class="name">futureDeprecated</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>This method is scheduled for deprecation in version 6.3.</p> +<p>Use something else instead.</p> +<p>This is a method that's marked for deprecation in a future version.</p> +</div></div><!-- @@@futureDeprecated --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-yetanotherchild-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-yetanotherchild-members.html new file mode 100644 index 000000000..fbab41876 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-yetanotherchild-members.html @@ -0,0 +1,19 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="A type inheriting from internal abstract parent."> + <title>List of All Members for YetAnotherChild | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>YetAnotherChild</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for YetAnotherChild</h1> +<p>This is the complete list of members for <a href="qml-qdoc-test-yetanotherchild.html">YetAnotherChild</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-yetanotherchild.html#prop-prop" translate="no">prop</a></b> : int</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-yetanotherchild.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-yetanotherchild.html new file mode 100644 index 000000000..2ecc87355 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-qdoc-test-yetanotherchild.html @@ -0,0 +1,48 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="A type inheriting from internal abstract parent."> + <title>YetAnotherChild QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>YetAnotherChild</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">YetAnotherChild QML Type</h1> +<!-- $$$YetAnotherChild-brief --> +<p>A type inheriting from internal abstract parent. <a href="#details">More...</a></p> +<!-- @@@YetAnotherChild --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr></table></div><ul> +<li><a href="qml-qdoc-test-yetanotherchild-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-yetanotherchild.html#prop-prop" translate="no">prop</a></b> : int</li> +</ul> +<!-- $$$YetAnotherChild-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@YetAnotherChild --> +<h2>Property Documentation</h2> +<!-- $$$prop --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="prop-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">prop</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Propagated to inheriting type docs.</p> +</div></div><!-- @@@prop --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-doctest-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-doctest-members.html new file mode 100644 index 000000000..491427692 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-doctest-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- DocTest.qml --> + <meta name="description" content="Shadows the type name in QDoc.Test module."> + <title>List of All Members for DocTest | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="test-nover-qmlmodule.html" translate="no">Test.NoVer (Tech Preview)</a></li> +<li>DocTest</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for DocTest</h1> +<p>This is the complete list of members for <a href="qml-test-nover-doctest.html">DocTest</a>, including inherited members.</p> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-doctest.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-doctest.html new file mode 100644 index 000000000..2543b3ce3 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-doctest.html @@ -0,0 +1,33 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- DocTest.qml --> + <meta name="description" content="Shadows the type name in QDoc.Test module."> + <title>DocTest QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="test-nover-qmlmodule.html" translate="no">Test.NoVer (Tech Preview)</a></li> +<li>DocTest</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">DocTest QML Type</h1> +<!-- $$$DocTest-brief --> +<p>Shadows the type name in QDoc.Test module. <a href="#details">More...</a></p> +<!-- @@@DocTest --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Test.NoVer</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Status:</td><td class="memItemRight bottomAlign"> Tech Preview<span class="status tech-preview"></span></td></tr></table></div><ul> +<li><a href="qml-test-nover-doctest-members.html">List of all members, including inherited members</a></li> +</ul> +<!-- $$$DocTest-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@DocTest --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-typenoversion-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-typenoversion-members.html new file mode 100644 index 000000000..ca2308045 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-typenoversion-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="Another QML type documented in a .cpp file."> + <title>List of All Members for TypeNoVersion | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="test-nover-qmlmodule.html" translate="no">Test.NoVer (Tech Preview)</a></li> +<li>TypeNoVersion</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for TypeNoVersion</h1> +<p>This is the complete list of members for <a href="qml-test-nover-typenoversion.html">TypeNoVersion</a>, including inherited members.</p> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-typenoversion.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-typenoversion.html new file mode 100644 index 000000000..b754038d9 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-test-nover-typenoversion.html @@ -0,0 +1,33 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="Another QML type documented in a .cpp file."> + <title>TypeNoVersion QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="test-nover-qmlmodule.html" translate="no">Test.NoVer (Tech Preview)</a></li> +<li>TypeNoVersion</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TypeNoVersion QML Type</h1> +<!-- $$$TypeNoVersion-brief --> +<p>Another QML type documented in a .cpp file. <a href="#details">More...</a></p> +<!-- @@@TypeNoVersion --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Test.NoVer</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Status:</td><td class="memItemRight bottomAlign"> Tech Preview<span class="status tech-preview"></span></td></tr></table></div><ul> +<li><a href="qml-test-nover-typenoversion-members.html">List of all members, including inherited members</a></li> +</ul> +<!-- $$$TypeNoVersion-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@TypeNoVersion --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-themodule-thetype-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-themodule-thetype-members.html new file mode 100644 index 000000000..de3143219 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-themodule-thetype-members.html @@ -0,0 +1,19 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- properties.qdoc --> + <title>List of All Members for TheType | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="themodule-qmlmodule.html" translate="no">TheModule</a></li> +<li>TheType</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for TheType</h1> +<p>This is the complete list of members for <a href="qml-themodule-thetype.html">TheType</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-themodule-thetype.html#name-prop" translate="no">name</a></b> : string</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-themodule-thetype.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-themodule-thetype.html new file mode 100644 index 000000000..86b8fd066 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-themodule-thetype.html @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- properties.qdoc --> + <title>TheType QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="themodule-qmlmodule.html" translate="no">TheModule</a></li> +<li>TheType</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TheType QML Type</h1> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import TheModule</td></tr><tr><td class="memItemLeft rightAlign topAlign"> In C++:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-testderived.html" translate="no">TestDerived</a></td></tr></table></div><ul> +<li><a href="qml-themodule-thetype-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-themodule-thetype.html#name-prop" translate="no">name</a></b> : string</li> +</ul> +<!-- $$$TheType-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@TheType --> +<h2>Property Documentation</h2> +<!-- $$$name --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">name</span> : <span class="type">string</span> <code class="details extra" translate="no">[read-only]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Read-only status of this property is resolved from Q_PROPERTY.</p> +</div></div><!-- @@@name --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-progressbar-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-progressbar-members.html new file mode 100644 index 000000000..77c4ef164 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-progressbar-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- ProgressBar.qml --> + <meta name="description" content="A component that shows the progress of an event."> + <title>List of All Members for ProgressBar | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="uicomponents-qmlmodule.html" translate="no">UIComponents</a></li> +<li>ProgressBar</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for ProgressBar</h1> +<p>This is the complete list of members for <a href="qml-uicomponents-progressbar.html">ProgressBar</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#color-prop" translate="no">color</a></b> : color</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#maximum-prop" translate="no">maximum</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#minimum-prop" translate="no">minimum</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#secondColor-prop" translate="no">secondColor</a></b> : color</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#value-prop" translate="no">value</a></b> : int</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-progressbar.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-progressbar.html new file mode 100644 index 000000000..b491e2eec --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-progressbar.html @@ -0,0 +1,98 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- ProgressBar.qml --> + <meta name="description" content="A component that shows the progress of an event."> + <title>ProgressBar QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="uicomponents-qmlmodule.html" translate="no">UIComponents</a></li> +<li>ProgressBar</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">ProgressBar QML Type</h1> +<!-- $$$ProgressBar-brief --> +<p>A component that shows the progress of an event. <a href="#details">More...</a></p> +<!-- @@@ProgressBar --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import UIComponents 1.0</td></tr></table></div><ul> +<li><a href="qml-uicomponents-progressbar-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#color-prop" translate="no">color</a></b> : color</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#maximum-prop" translate="no">maximum</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#minimum-prop" translate="no">minimum</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#secondColor-prop" translate="no">secondColor</a></b> : color</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-progressbar.html#value-prop" translate="no">value</a></b> : int</li> +</ul> +<!-- $$$ProgressBar-description --> +<h2 id="details">Detailed Description</h2> +<p>A ProgressBar shows the linear progress of an event as its <a href="qml-uicomponents-progressbar.html#value-prop" translate="no">value</a>. The range is specified using the <a href="qml-uicomponents-progressbar.html#minimum-prop" translate="no">minimum</a> and the <a href="qml-uicomponents-progressbar.html#maximum-prop" translate="no">maximum</a> values.</p> +<p>The ProgressBar component is part of the <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module.</p> +<p>This documentation is part of the <a href="test-componentset-example.html">UIComponents</a> example.</p> +<!-- @@@ProgressBar --> +<h2>Property Documentation</h2> +<!-- $$$color --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="color-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">color</span> : <span class="type">color</span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>The color of the <a href="qml-uicomponents-progressbar.html" translate="no">ProgressBar</a>'s gradient. Must bind to a color type.</p> +<p><b>See also </b><a href="qml-uicomponents-progressbar.html#secondColor-prop" translate="no">secondColor</a>.</p> +</div></div><!-- @@@color --> +<br/> +<!-- $$$maximum --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="maximum-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">maximum</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>The maximum value of the <a href="qml-uicomponents-progressbar.html" translate="no">ProgressBar</a> range. The <a href="qml-uicomponents-progressbar.html#value-prop" translate="no">value</a> must not be more than this value.</p> +</div></div><!-- @@@maximum --> +<br/> +<!-- $$$minimum --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="minimum-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">minimum</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>The minimum value of the <a href="qml-uicomponents-progressbar.html" translate="no">ProgressBar</a> range. The <a href="qml-uicomponents-progressbar.html#value-prop" translate="no">value</a> must not be less than this value.</p> +</div></div><!-- @@@minimum --> +<br/> +<!-- $$$secondColor --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="secondColor-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">secondColor</span> : <span class="type">color</span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>The second color of the <a href="qml-uicomponents-progressbar.html" translate="no">ProgressBar</a>'s gradient. Must bind to a color type.</p> +<p><b>See also </b><a href="qml-uicomponents-progressbar.html#color-prop" translate="no">color</a>.</p> +</div></div><!-- @@@secondColor --> +<br/> +<!-- $$$value --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="value-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">value</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>The value of the progress.</p> +</div></div><!-- @@@value --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-switch-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-switch-members.html new file mode 100644 index 000000000..df1cd735f --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-switch-members.html @@ -0,0 +1,21 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- Switch.qml --> + <meta name="description" content="A component that can be turned on or off."> + <title>List of All Members for Switch | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="uicomponents-qmlmodule.html" translate="no">UIComponents</a></li> +<li>Switch</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for Switch</h1> +<p>This is the complete list of members for <a href="qml-uicomponents-switch.html">Switch</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-uicomponents-switch.html#on-prop" translate="no">on</a></b> : bool</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-switch.html#toggle-method" translate="no">toggle</a></b>()</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-switch.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-switch.html new file mode 100644 index 000000000..8e3917a21 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-switch.html @@ -0,0 +1,68 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- Switch.qml --> + <meta name="description" content="A component that can be turned on or off."> + <title>Switch QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="uicomponents-qmlmodule.html" translate="no">UIComponents</a></li> +<li>Switch</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#methods">Methods</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Switch QML Type</h1> +<!-- $$$Switch-brief --> +<p>A component that can be turned on or off. <a href="#details">More...</a></p> +<!-- @@@Switch --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import UIComponents 1.0</td></tr></table></div><ul> +<li><a href="qml-uicomponents-switch-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-uicomponents-switch.html#on-prop" translate="no">on</a></b> : bool</li> +</ul> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-uicomponents-switch.html#toggle-method" translate="no">toggle</a></b>()</li> +</ul> +<!-- $$$Switch-description --> +<h2 id="details">Detailed Description</h2> +<p>A toggle switch has two states: an <code translate="no">on</code> and an <code translate="no">off</code> state. The <code translate="no">off</code> state is when the <a href="qml-uicomponents-switch.html#on-prop" translate="no">on</a> property is set to <code translate="no">false</code>.</p> +<p>The ToggleSwitch component is part of the <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module.</p> +<p>This documentation is part of the <a href="test-componentset-example.html">UIComponents</a> example.</p> +<!-- @@@Switch --> +<h2>Property Documentation</h2> +<!-- $$$on --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="on-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">on</span> : <span class="type">bool</span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Indicates the state of the switch. If <code translate="no">false</code>, then the switch is in the <code translate="no">off</code> state.</p> +</div></div><!-- @@@on --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$toggle[overload1]$$$toggle --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="toggle-method"> +<td class="tblQmlFuncNode"><p> +<span class="name">toggle</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>A method to toggle the switch. If the switch is <code translate="no">on</code>, the toggling it will turn it <code translate="no">off</code>. Toggling a switch in the <code translate="no">off</code> position will turn it <code translate="no">on</code>.</p> +</div></div><!-- @@@toggle --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-tabwidget-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-tabwidget-members.html new file mode 100644 index 000000000..cd459ceff --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-tabwidget-members.html @@ -0,0 +1,21 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- TabWidget.qml --> + <meta name="description" content="A widget that places its children as tabs."> + <title>List of All Members for TabWidget | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="uicomponents-qmlmodule.html" translate="no">UIComponents</a></li> +<li>TabWidget</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for TabWidget</h1> +<p>This is the complete list of members for <a href="qml-uicomponents-tabwidget.html">TabWidget</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-uicomponents-tabwidget.html#current-prop" translate="no">current</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-tabwidget.html#sampleReadOnlyProperty-prop" translate="no">sampleReadOnlyProperty</a></b> : int</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-tabwidget.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-tabwidget.html new file mode 100644 index 000000000..466262eca --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qml-uicomponents-tabwidget.html @@ -0,0 +1,84 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- TabWidget.qml --> + <meta name="description" content="A widget that places its children as tabs."> + <title>TabWidget QML Type | Test 6.2.11</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li><a href="uicomponents-qmlmodule.html" translate="no">UIComponents</a></li> +<li>TabWidget</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#adding-tabs">Adding Tabs</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TabWidget QML Type</h1> +<!-- $$$TabWidget-brief --> +<p>A widget that places its children as tabs. <a href="#details">More...</a></p> +<!-- @@@TabWidget --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import UIComponents 1.0</td></tr></table></div><ul> +<li><a href="qml-uicomponents-tabwidget-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-uicomponents-tabwidget.html#current-prop" translate="no">current</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-uicomponents-tabwidget.html#sampleReadOnlyProperty-prop" translate="no">sampleReadOnlyProperty</a></b> : int</li> +</ul> +<!-- $$$TabWidget-description --> +<h2 id="details">Detailed Description</h2> +<p>A TabWidget places its children as tabs in a view. Selecting a tab involves selecting the tab at the top.</p> +<p>The TabWidget component is part of the <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module.</p> +<p>This documentation is part of the <a href="test-componentset-example.html">UIComponents</a> example.</p> +<h2 id="adding-tabs">Adding Tabs</h2> +<p>To add a tab, declare the tab as a child of the TabWidget.</p> +<pre class="cpp" translate="no"><span class="type"><a href="qml-uicomponents-tabwidget.html" translate="no">TabWidget</a></span> { + <span class="name">id</span>: <span class="name">tabwidget</span> + + <span class="type">Rectangle</span> { + <span class="name">id</span>: <span class="name">tab1</span> + <span class="name">color</span>: <span class="string">"red"</span> + <span class="comment">//... omitted</span> + } + <span class="type">Rectangle</span> { + <span class="name">id</span>: <span class="name">tab2</span> + <span class="name">color</span>: <span class="string">"blue"</span> + <span class="comment">//... omitted</span> + } + +}</pre> +<!-- @@@TabWidget --> +<h2>Property Documentation</h2> +<!-- $$$current --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="current-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">current</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>The currently active tab in the <a href="qml-uicomponents-tabwidget.html" translate="no">TabWidget</a>.</p> +</div></div><!-- @@@current --> +<br/> +<!-- $$$sampleReadOnlyProperty --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="sampleReadOnlyProperty-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">sampleReadOnlyProperty</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span> <code class="details extra" translate="no">[read-only]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>A sample <code translate="no">read-only</code> property. A contrived property to demonstrate QDoc's ability to detect read-only properties.</p> +<p>The signature is:</p> +<pre class="cpp" translate="no">readonly property <span class="type"><a href="qml-int.html" translate="no">int</a></span> sampleReadOnlyProperty: <span class="number">0</span></pre> +<p>Note that the property must be initialized to a value.</p> +</div></div><!-- @@@sampleReadOnlyProperty --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qmlmodules.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qmlmodules.html new file mode 100644 index 000000000..bd0238d40 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/qmlmodules.html @@ -0,0 +1,49 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- modules.qdoc --> + <title>QML Modules | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#qml-types">QML types</a></li> +<li class="level1"><a href="#qml-value-types">QML value types</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">QML Modules</h1> +<!-- $$$qmlmodules.html-description --> +<div class="descr" id="details"> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="test-empty-qmlmodule.html">No QML Types Here</a></p></td><td class="tblDescr"><p>A QML module with no member types.</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qdoc-test-qmlmodule.html">QDoc.Test QML Module</a></p></td><td class="tblDescr"><p>QML Types for the Test module.</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="themodule-qmlmodule.html">TheModule</a></p></td><td class="tblDescr"><p></p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="uicomponents-qmlmodule.html">UI Components</a></p></td><td class="tblDescr"><p>Basic set of UI components.</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="test-nover-qmlmodule.html">Versionless QML Module</a></p></td><td class="tblDescr"><p>QML Types for the Test module without version.</p></td></tr> +</table></div> +<h2 id="qml-types">QML types</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-abstractparent.html">AbstractParent</a></p></td><td class="tblDescr"><p>Abstract base QML type</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-child.html">Child</a></p></td><td class="tblDescr"><p>A Child inheriting its parent</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-doctest.html">DocTest</a></p></td><td class="tblDescr"><p>Represents a doc test case</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-type.html">Type</a></p></td><td class="tblDescr"><p>A QML type documented in a .cpp file</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-yetanotherchild.html">YetAnotherChild</a></p></td><td class="tblDescr"><p>A type inheriting from internal abstract parent</p></td></tr> +</table></div> +<h2 id="qml-value-types">QML value types</h2> +<p class="centerAlign functionIndex" translate="no"><b><a href="#i">I</a> </b></p> +<div class="flowListDiv" translate="no"> +<dl class="flowList odd"><dt class="alphaChar" id="i"><b>I</b></dt> +<dd><a href="qml-int.html">int</a></dd> +</dl> +</div> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-int.html">int</a></p></td><td class="tblDescr"><p>An integer value type</p></td></tr> +</table></div> +</div> +<!-- @@@qmlmodules.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/seenclass.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/seenclass.html new file mode 100644 index 000000000..ece82ceb7 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/seenclass.html @@ -0,0 +1,37 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- dont.cpp --> + <meta name="description" content="A public but undocumented class."> + <title>SeenClass Class | Test 6.2.11</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>SeenClass</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">SeenClass Class</h1> +<!-- $$$SeenClass-brief --> +<p>A public but undocumented class. <a href="#details">More...</a></p> +<!-- @@@SeenClass --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <SeenClass></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 2.0</td></tr> +</table></div> +<!-- $$$SeenClass-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@SeenClass --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-cmakelists-txt.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-cmakelists-txt.html new file mode 100644 index 000000000..8072df6db --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-cmakelists-txt.html @@ -0,0 +1,11 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- cmaketest.qdoc --> + <title>CMake Example Project | Test 6.2.11</title> +</head> +<body> +<h1 class="title">CMake Example Project</h1> +<pre class="cpp" translate="no">cmake_minimum_required(VERSION 3.16) +project (QDOCTEST)</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-example.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-example.html new file mode 100644 index 000000000..a9ebe9784 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-example.html @@ -0,0 +1,21 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- cmaketest.qdoc --> + <title>CMake Example Project | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">CMake Example Project</h1> +<!-- $$$cmaketest-description --> +<div class="descr" id="details"> +<p class="centerAlign"><img src="images/leonardo-da-vinci.png" alt="" /></p><p>Files:</p> +<ul> +<li><a href="test-cmaketest-cmakelists-txt.html" translate="no">cmaketest/CMakeLists.txt</a></li> +<li><a href="test-cmaketest-main-cpp.html" translate="no">cmaketest/main.cpp</a></li> +</ul> +</div> +<!-- @@@cmaketest --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-main-cpp.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-main-cpp.html new file mode 100644 index 000000000..0acb90579 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-cmaketest-main-cpp.html @@ -0,0 +1,10 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- cmaketest.qdoc --> + <title>CMake Example Project | Test 6.2.11</title> +</head> +<body> +<h1 class="title">CMake Example Project</h1> +<pre class="cpp" translate="no"><span class="type">void</span> main(){}</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-componentset-pro.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-componentset-pro.html new file mode 100644 index 000000000..0589f516e --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-componentset-pro.html @@ -0,0 +1,15 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- examples.qdoc --> + <meta name="description" content="Example for documenting QML types."> + <title>QML Documentation Example | Test 6.2.11</title> +</head> +<body> +<h1 class="title">QML Documentation Example</h1> +<pre class="cpp" translate="no">SOURCES = componentset.pro \ + ProgressBar.qml \ + Switch.qml \ + TabWidget.qml \ + uicomponents.qdoc</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-componentset-qml.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-componentset-qml.html new file mode 100644 index 000000000..8d50b2a3a --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-componentset-qml.html @@ -0,0 +1,17 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- examples.qdoc --> + <meta name="description" content="Example for documenting QML types."> + <title>QML Documentation Example | Test 6.2.11</title> +</head> +<body> +<h1 class="title">QML Documentation Example</h1> +<pre class="qml" translate="no"><span class="comment">// Copyright (C) 2023 The Qt Company Ltd.</span> +<span class="comment">// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0</span> + +import QtQuick 2.0 + +<span class="type">Item</span> { +}</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-example.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-example.html new file mode 100644 index 000000000..8227ff937 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-example.html @@ -0,0 +1,55 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- examples.qdoc --> + <meta name="description" content="Example for documenting QML types."> + <title>QML Documentation Example | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#qml-class">QML Class</a></li> +<li class="level1"><a href="#properties-signals-handlers-and-methods">Properties, Signals, Handlers, and Methods</a></li> +<li class="level2"><a href="#internal-documentation">Internal Documentation</a></li> +<li class="level1"><a href="#qml-types-with-c-implementation">QML Types with C++ Implementation</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">QML Documentation Example</h1> +<!-- $$$componentset-brief --> +<p>Example for documenting QML types.</p> +<!-- @@@componentset --> +<!-- $$$componentset-description --> +<div class="descr" id="details"> +<p>This example demonstrates one of the ways to document QML types. It also generates a warning about a missing example image, on purpose.</p> +<p>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 <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module.</p> +<p>The uicomponents.qdoc file generates the overview page for the <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module page.</p> +<p>The generated documentation is available in the <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module.</p> +<h4 id="qml-class">QML Class</h4> +<p>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 <code translate="no">UIComponents</code> module.</p> +<p>QDoc uses the \brief command to place a basic description when listing the types.</p> +<h4 id="properties-signals-handlers-and-methods">Properties, Signals, Handlers, and Methods</h4> +<p>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.</p> +<p>To document the type of a <i>property alias</i>, you must use the \qmlproperty command to specify the data type.</p> +<pre class="cpp" translate="no">\qmlproperty <span class="type">int</span> anAliasedProperty +An aliased property of type <span class="type">int</span><span class="operator">.</span></pre> +<h5 id="internal-documentation">Internal Documentation</h5> +<p>You may declare that a documentation is for internal use by placing the \internal command after the beginning QDoc comment <code translate="no">/*</code>. QDoc will prevent the internal documentation from appearing in the public API.</p> +<p>If you wish to omit certain parts of the documentation, you may use the \omit and \endomit command.</p> +<h4 id="qml-types-with-c-implementation">QML Types with C++ Implementation</h4> +<p>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.</p> +<p>Files:</p> +<ul> +<li><a href="test-componentset-progressbar-qml.html" translate="no">componentset/ProgressBar.qml</a></li> +<li><a href="test-componentset-switch-qml.html" translate="no">componentset/Switch.qml</a></li> +<li><a href="test-componentset-tabwidget-qml.html" translate="no">componentset/TabWidget.qml</a></li> +<li><a href="test-componentset-componentset-pro.html" translate="no">componentset/componentset.pro</a></li> +<li><a href="test-componentset-componentset-qml.html" translate="no">componentset/componentset.qml</a></li> +</ul> +</div> +<!-- @@@componentset --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-progressbar-qml.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-progressbar-qml.html new file mode 100644 index 000000000..41c9c506a --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-progressbar-qml.html @@ -0,0 +1,108 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- examples.qdoc --> + <meta name="description" content="Example for documenting QML types."> + <title>QML Documentation Example | Test 6.2.11</title> +</head> +<body> +<h1 class="title">QML Documentation Example</h1> +<pre class="qml" translate="no"><span class="comment">// Copyright (C) 2016 The Qt Company Ltd.</span> +<span class="comment">// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause</span> + +import QtQuick 1.0 + +<span class="comment">/*! + \qmltype ProgressBar + \inqmlmodule UIComponents + \brief A component that shows the progress of an event. + + A ProgressBar shows the linear progress of an event as its \l value. + The range is specified using the \l {minimum} and the \l{maximum} values. + + The ProgressBar component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. +*/</span> +<span class="type">Item</span> { + <span class="name">id</span>: <span class="name">progressbar</span> + + <span class="comment">/*! + The minimum value of the ProgressBar range. + The \l value must not be less than this value. + */</span> + property <span class="type"><a href="qml-int.html" translate="no">int</a></span> <span class="name">minimum</span>: <span class="number">0</span> + + <span class="comment">/*! + The maximum value of the ProgressBar range. + The \l value must not be more than this value. + */</span> + property <span class="type"><a href="qml-int.html" translate="no">int</a></span> <span class="name">maximum</span>: <span class="number">100</span> + + <span class="comment">/*! + The value of the progress. + */</span> + property <span class="type"><a href="qml-int.html" translate="no">int</a></span> <span class="name">value</span>: <span class="number">0</span> + + <span class="comment">/*! + \qmlproperty color ProgressBar::color + The color of the ProgressBar's gradient. Must bind to a color type. + + \omit + The "\qmlproperty <type> <property name>" is needed because + property alias need to have their types manually entered. + + QDoc will not publish the documentation within omit and endomit. + \endomit + + \sa secondColor + */</span> + property <span class="type">alias</span> <span class="name">color</span>: <span class="name">gradient1</span>.<span class="name">color</span> + + <span class="comment">/*! + \qmlproperty color ProgressBar::secondColor + The second color of the ProgressBar's gradient. + Must bind to a color type. + + \omit + The "\qmlproperty <type> <property name>" is needed because + property alias need to have their types manually entered. + + QDoc will not publish the documentation within omit and endomit. + \endomit + + \sa color + */</span> + property <span class="type">alias</span> <span class="name">secondColor</span>: <span class="name">gradient2</span>.<span class="name">color</span> + + <span class="name">width</span>: <span class="number">250</span>; <span class="name">height</span>: <span class="number">23</span> + <span class="name">clip</span>: <span class="number">true</span> + + <span class="type">Rectangle</span> { + <span class="name">id</span>: <span class="name">highlight</span> + + <span class="comment">/*! + An internal documentation comment. The widthDest property is not + a public API and therefore will not be exposed. + */</span> + property <span class="type"><a href="qml-int.html" translate="no">int</a></span> <span class="name">widthDest</span>: ((<span class="name">progressbar</span>.<span class="name">width</span> <span class="operator">*</span> (<span class="name">value</span> <span class="operator">-</span> <span class="name">minimum</span>)) <span class="operator">/</span> (<span class="name">maximum</span> <span class="operator">-</span> <span class="name">minimum</span>) <span class="operator">-</span> <span class="number">6</span>) + + <span class="name">width</span>: <span class="name">highlight</span>.<span class="name">widthDest</span> + Behavior on <span class="name">width</span> { <span class="type">SmoothedAnimation</span> { <span class="name">velocity</span>: <span class="number">1200</span> } } + + <span class="type">anchors</span> { <span class="name">left</span>: <span class="name">parent</span>.<span class="name">left</span>; <span class="name">top</span>: <span class="name">parent</span>.<span class="name">top</span>; <span class="name">bottom</span>: <span class="name">parent</span>.<span class="name">bottom</span>; <span class="name">margins</span>: <span class="number">3</span> } + <span class="name">radius</span>: <span class="number">1</span> + <span class="name">gradient</span>: <span class="name">Gradient</span> { + <span class="type">GradientStop</span> { <span class="name">id</span>: <span class="name">gradient1</span>; <span class="name">position</span>: <span class="number">0.0</span> } + <span class="type">GradientStop</span> { <span class="name">id</span>: <span class="name">gradient2</span>; <span class="name">position</span>: <span class="number">1.0</span> } + } + + } + <span class="type">Text</span> { + <span class="type">anchors</span> { <span class="name">right</span>: <span class="name">highlight</span>.<span class="name">right</span>; <span class="name">rightMargin</span>: <span class="number">6</span>; <span class="name">verticalCenter</span>: <span class="name">parent</span>.<span class="name">verticalCenter</span> } + <span class="name">color</span>: <span class="string">"white"</span> + <span class="name">font</span>.bold: <span class="number">true</span> + <span class="name">text</span>: <span class="name">Math</span>.<span class="name">floor</span>((<span class="name">value</span> <span class="operator">-</span> <span class="name">minimum</span>) <span class="operator">/</span> (<span class="name">maximum</span> <span class="operator">-</span> <span class="name">minimum</span>) <span class="operator">*</span> <span class="number">100</span>) <span class="operator">+</span> <span class="string">'%'</span> + } +}</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-switch-qml.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-switch-qml.html new file mode 100644 index 000000000..958f2f19b --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-switch-qml.html @@ -0,0 +1,113 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- examples.qdoc --> + <meta name="description" content="Example for documenting QML types."> + <title>QML Documentation Example | Test 6.2.11</title> +</head> +<body> +<h1 class="title">QML Documentation Example</h1> +<pre class="qml" translate="no"><span class="comment">// Copyright (C) 2016 The Qt Company Ltd.</span> +<span class="comment">// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause</span> + +import QtQuick 1.0 + +<span class="comment">/*! + \qmltype ToggleSwitch + \inqmlmodule UIComponents + \brief A component that can be turned on or off. + + A toggle switch has two states: an \c on and an \c off state. The \c off + state is when the \l on property is set to \c false. + + The ToggleSwitch component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. + +*/</span> +<span class="type">Item</span> { + <span class="name">id</span>: <span class="name">toggleswitch</span> + <span class="name">width</span>: <span class="name">background</span>.<span class="name">width</span>; <span class="name">height</span>: <span class="name">background</span>.<span class="name">height</span> + + <span class="comment">/*! + Indicates the state of the switch. If \c false, then the switch is in + the \c off state. + + \omit + The \qmlproperty <type> <propertyname> is not necessary as QDoc + will associate this property to the ToggleSwitch + + QDoc will not publish the documentation within omit and endomit. + \endomit + */</span> + property <span class="type">bool</span> <span class="name">on</span>: <span class="number">false</span> + + <span class="comment">/*! + A method to toggle the switch. If the switch is \c on, the toggling it + will turn it \c off. Toggling a switch in the \c off position will + turn it \c on. + */</span> + <span class="keyword">function </span><span class="name">toggle</span>() { + <span class="keyword">if</span> (<span class="name">toggleswitch</span>.<span class="name">state</span> <span class="operator">==</span> <span class="string">"on"</span>) + <span class="name">toggleswitch</span>.<span class="name">state</span> <span class="operator">=</span> <span class="string">"off"</span>; + <span class="keyword">else</span> + <span class="name">toggleswitch</span>.<span class="name">state</span> <span class="operator">=</span> <span class="string">"on"</span>; + } + + <span class="comment">/*! + \internal + + An internal function to synchronize the switch's internals. This + function is not for public access. The \internal command will + prevent QDoc from publishing this comment in the public API. + */</span> + <span class="keyword">function </span><span class="name">releaseSwitch</span>() { + <span class="keyword">if</span> (<span class="name">knob</span>.<span class="name">x</span> <span class="operator">==</span> <span class="number">1</span>) { + <span class="keyword">if</span> (<span class="name">toggleswitch</span>.<span class="name">state</span> <span class="operator">==</span> <span class="string">"off"</span>) <span class="keyword">return</span>; + } + <span class="keyword">if</span> (<span class="name">knob</span>.<span class="name">x</span> <span class="operator">==</span> <span class="number">78</span>) { + <span class="keyword">if</span> (<span class="name">toggleswitch</span>.<span class="name">state</span> <span class="operator">==</span> <span class="string">"on"</span>) <span class="keyword">return</span>; + } + <span class="name">toggle</span>(); + } + + <span class="type">Rectangle</span> { + <span class="name">id</span>: <span class="name">background</span> + <span class="name">width</span>: <span class="number">130</span>; <span class="name">height</span>: <span class="number">48</span> + <span class="name">radius</span>: <span class="number">48</span> + <span class="name">color</span>: <span class="string">"lightsteelblue"</span> + <span class="type">MouseArea</span> { <span class="name">anchors</span>.fill: <span class="name">parent</span>; <span class="name">onClicked</span>: <span class="name">toggle</span>() } + } + + <span class="type">Rectangle</span> { + <span class="name">id</span>: <span class="name">knob</span> + <span class="name">width</span>: <span class="number">48</span>; <span class="name">height</span>: <span class="number">48</span> + <span class="name">radius</span>: <span class="name">width</span> + <span class="name">color</span>: <span class="string">"lightblue"</span> + + <span class="type">MouseArea</span> { + <span class="name">anchors</span>.fill: <span class="name">parent</span> + <span class="name">drag</span>.target: <span class="name">knob</span>; <span class="name">drag</span>.axis: <span class="name">Drag</span>.<span class="name">XAxis</span>; <span class="name">drag</span>.minimumX: <span class="number">1</span>; <span class="name">drag</span>.maximumX: <span class="number">78</span> + <span class="name">onClicked</span>: <span class="name">toggle</span>() + <span class="name">onReleased</span>: <span class="name">releaseSwitch</span>() + } + } + + <span class="name">states</span>: [ + <span class="type">State</span> { + <span class="name">name</span>: <span class="string">"on"</span> + <span class="type">PropertyChanges</span> { <span class="name">target</span>: <span class="name">knob</span>; <span class="name">x</span>: <span class="number">78</span> } + <span class="type">PropertyChanges</span> { <span class="name">target</span>: <span class="name">toggleswitch</span>; <span class="name">on</span>: <span class="number">true</span> } + }, + <span class="type">State</span> { + <span class="name">name</span>: <span class="string">"off"</span> + <span class="type">PropertyChanges</span> { <span class="name">target</span>: <span class="name">knob</span>; <span class="name">x</span>: <span class="number">1</span> } + <span class="type">PropertyChanges</span> { <span class="name">target</span>: <span class="name">toggleswitch</span>; <span class="name">on</span>: <span class="number">false</span> } + } + ] + + <span class="name">transitions</span>: <span class="name">Transition</span> { + <span class="type">NumberAnimation</span> { <span class="name">properties</span>: <span class="string">"x"</span>; <span class="name">easing</span>.type: <span class="name">Easing</span>.<span class="name">InOutQuad</span>; <span class="name">duration</span>: <span class="number">200</span> } + } +}</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-tabwidget-qml.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-tabwidget-qml.html new file mode 100644 index 000000000..ea6116dca --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-componentset-tabwidget-qml.html @@ -0,0 +1,155 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- examples.qdoc --> + <meta name="description" content="Example for documenting QML types."> + <title>QML Documentation Example | Test 6.2.11</title> +</head> +<body> +<h1 class="title">QML Documentation Example</h1> +<pre class="qml" translate="no"><span class="comment">// Copyright (C) 2016 The Qt Company Ltd.</span> +<span class="comment">// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause</span> + +import QtQuick 1.0 + +<span class="comment">/*! + \qmltype TabWidget + \inqmlmodule UIComponents + \brief A widget that places its children as tabs. + + A TabWidget places its children as tabs in a view. Selecting + a tab involves selecting the tab at the top. + + The TabWidget component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. + + \section1 Adding Tabs + + To add a tab, declare the tab as a child of the TabWidget. + + \code + TabWidget { + id: tabwidget + + Rectangle { + id: tab1 + color: "red" + //... omitted + } + Rectangle { + id: tab2 + color: "blue" + //... omitted + } + + } + \endcode + +*/</span> +<span class="type">Item</span> { + <span class="name">id</span>: <span class="name">tabWidget</span> + + <span class="comment">/*! + \internal + + Setting the default property to stack.children means any child items + of the TabWidget are actually added to the 'stack' item's children. + + See the \l{"Property Binding in QML"} + documentation for details on default properties. + + This is an implementation detail, not meant for public knowledge. Putting + the \internal command at the beginning will cause QDoc to not publish this + documentation in the public API page. + + Normally, a property alias needs to have a + "\qmlproperty <type> <propertyname>" to assign the alias a type. + + */</span> + default property <span class="type">alias</span> <span class="name">content</span>: <span class="name">stack</span>.<span class="name">children</span> + + <span class="comment">/*! + The currently active tab in the TabWidget. + */</span> + property <span class="type"><a href="qml-int.html" translate="no">int</a></span> <span class="name">current</span>: <span class="number">0</span> + + <span class="comment">/*! + A sample \c{read-only} property. + A contrived property to demonstrate QDoc's ability to detect + read-only properties. + + The signature is: + \code + readonly property int sampleReadOnlyProperty: 0 + \endcode + + Note that the property must be initialized to a value. + + */</span> + readonly property <span class="type"><a href="qml-int.html" translate="no">int</a></span> <span class="name">sampleReadOnlyProperty</span>: <span class="number">0</span> + + <span class="comment">/*! + \internal + + This handler is an implementation + detail. The \c{\internal} command will prevent QDoc from publishing this + documentation on the public API. + */</span> + <span class="name">onCurrentChanged</span>: <span class="name">setOpacities</span>() + <span class="name">Component</span>.onCompleted: <span class="name">setOpacities</span>() + + <span class="comment">/*! + \internal + + An internal function to set the opacity. + The \internal command will prevent QDoc from publishing this + documentation on the public API. + */</span> + <span class="keyword">function </span><span class="name">setOpacities</span>() { + <span class="keyword">for</span> (var i = 0; <span class="name">i</span> <span class="operator"><</span> <span class="name">stack</span>.<span class="name">children</span>.<span class="name">length</span>; ++<span class="name">i</span>) { + <span class="name">stack</span>.<span class="name">children</span>[<span class="name">i</span>].<span class="name">opacity</span> <span class="operator">=</span> (<span class="name">i</span> <span class="operator">==</span> <span class="name">current</span> ? <span class="number">1</span> : <span class="number">0</span>) + } + } + + <span class="type">Row</span> { + <span class="name">id</span>: <span class="name">header</span> + + <span class="type">Repeater</span> { + <span class="name">model</span>: <span class="name">stack</span>.<span class="name">children</span>.<span class="name">length</span> + <span class="name">delegate</span>: <span class="name">Rectangle</span> { + <span class="name">width</span>: <span class="name">tabWidget</span>.<span class="name">width</span> <span class="operator">/</span> <span class="name">stack</span>.<span class="name">children</span>.<span class="name">length</span>; <span class="name">height</span>: <span class="number">36</span> + + <span class="type">Rectangle</span> { + <span class="name">width</span>: <span class="name">parent</span>.<span class="name">width</span>; <span class="name">height</span>: <span class="number">1</span> + <span class="type">anchors</span> { <span class="name">bottom</span>: <span class="name">parent</span>.<span class="name">bottom</span>; <span class="name">bottomMargin</span>: <span class="number">1</span> } + <span class="name">color</span>: <span class="string">"#acb2c2"</span> + } + <span class="type">BorderImage</span> { + <span class="type">anchors</span> { <span class="name">fill</span>: <span class="name">parent</span>; <span class="name">leftMargin</span>: <span class="number">2</span>; <span class="name">topMargin</span>: <span class="number">5</span>; <span class="name">rightMargin</span>: <span class="number">1</span> } + <span class="type">border</span> { <span class="name">left</span>: <span class="number">7</span>; <span class="name">right</span>: <span class="number">7</span> } + <span class="name">source</span>: <span class="string">"tab.png"</span> + <span class="name">visible</span>: <span class="name">tabWidget</span>.<span class="name">current</span> <span class="operator">==</span> <span class="name">index</span> + } + <span class="type">Text</span> { + <span class="name">horizontalAlignment</span>: <span class="name">Qt</span>.<span class="name">AlignHCenter</span>; <span class="name">verticalAlignment</span>: <span class="name">Qt</span>.<span class="name">AlignVCenter</span> + <span class="name">anchors</span>.fill: <span class="name">parent</span> + <span class="name">text</span>: <span class="name">stack</span>.<span class="name">children</span>[<span class="name">index</span>].<span class="name">title</span> + <span class="name">elide</span>: <span class="name">Text</span>.<span class="name">ElideRight</span> + <span class="name">font</span>.bold: <span class="name">tabWidget</span>.<span class="name">current</span> <span class="operator">==</span> <span class="name">index</span> + } + <span class="type">MouseArea</span> { + <span class="name">anchors</span>.fill: <span class="name">parent</span> + <span class="name">onClicked</span>: <span class="name">tabWidget</span>.<span class="name">current</span> <span class="operator">=</span> <span class="name">index</span> + } + } + } + } + + <span class="type">Item</span> { + <span class="name">id</span>: <span class="name">stack</span> + <span class="name">width</span>: <span class="name">tabWidget</span>.<span class="name">width</span> + <span class="name">anchors</span>.top: <span class="name">header</span>.<span class="name">bottom</span>; <span class="name">anchors</span>.bottom: <span class="name">tabWidget</span>.<span class="name">bottom</span> + } +}</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-demo-cpp.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-demo-cpp.html new file mode 100644 index 000000000..6e1f68232 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-demo-cpp.html @@ -0,0 +1,18 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- demo.qdoc --> + <title>Demo | Test 6.2.11</title> +</head> +<body> +<h1 class="title">Demo</h1> +<pre class="cpp" translate="no"><span class="comment">// Copyright (C) 2023 The Qt Company Ltd.</span> +<span class="comment">// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0</span> + +<span class="type">bool</span> isOverThousand(<span class="type">int</span> n) +{ + <span class="keyword">if</span> (n <span class="operator">></span> <span class="number">1'000</span>) + <span class="keyword">return</span> <span class="keyword">true</span>; + <span class="keyword">return</span> <span class="keyword">false</span>; +}</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-demo-pro.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-demo-pro.html new file mode 100644 index 000000000..3d59c65b3 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-demo-pro.html @@ -0,0 +1,11 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- demo.qdoc --> + <title>Demo | Test 6.2.11</title> +</head> +<body> +<h1 class="title">Demo</h1> +<pre class="cpp" translate="no">TEMPLATE = aux +message("Nothing to see here.")</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-dontxclude-cmakelists-txt.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-dontxclude-cmakelists-txt.html new file mode 100644 index 000000000..c654a3768 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-dontxclude-cmakelists-txt.html @@ -0,0 +1,11 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- demo.qdoc --> + <title>Demo | Test 6.2.11</title> +</head> +<body> +<h1 class="title">Demo</h1> +<pre class="cpp" translate="no">cmake_minimum_required(VERSION 3.16) +project (DONTXCLUDEDIRS_QDOCTEST)</pre> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-example.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-example.html new file mode 100644 index 000000000..8f7c9ace8 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-demo-example.html @@ -0,0 +1,24 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- demo.qdoc --> + <title>Demo | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Demo</h1> +<!-- $$$demos/demo-description --> +<div class="descr" id="details"> +<p class="centerAlign"><img src="images/leonardo-da-vinci.png" alt="" /></p><pre class="cpp" translate="no"> <span class="keyword">if</span> (n <span class="operator">></span> <span class="number">1'000</span>) + <span class="keyword">return</span> <span class="keyword">true</span>;</pre> +<p>Files:</p> +<ul> +<li><a href="test-demos-demo-demo-cpp.html" translate="no">demos/demo/demo.cpp</a></li> +<li><a href="test-demos-demo-demo-pro.html" translate="no">demos/demo/demo.pro</a></li> +<li><a href="test-demos-demo-dontxclude-cmakelists-txt.html" translate="no">demos/demo/dontxclude/CMakeLists.txt</a></li> +</ul> +</div> +<!-- @@@demos/demo --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-hidden-example.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-hidden-example.html new file mode 100644 index 000000000..fc123ba60 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-demos-hidden-example.html @@ -0,0 +1,21 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- hidden.qdoc --> + <meta name="description" content="Tagged 'broken', does not appear in examples-manifest.xml."> + <title>Hidden Demo | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Hidden Demo</h1> +<!-- $$$demos/hidden-brief --> +<p>Tagged 'broken', does not appear in examples-manifest.xml.</p> +<!-- @@@demos/hidden --> +<!-- $$$demos/hidden-description --> +<div class="descr" id="details"> +<p>Also missing an image, but that's OK as it's broken anyway.</p> +</div> +<!-- @@@demos/hidden --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-empty-qmlmodule.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-empty-qmlmodule.html new file mode 100644 index 000000000..eabda8b7a --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-empty-qmlmodule.html @@ -0,0 +1,17 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="A QML module with no member types."> + <title>No QML Types Here | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">No QML Types Here</h1> +<!-- $$$Test.Empty-description --> +<div class="descr" id="details"> +</div> +<!-- @@@Test.Empty --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-nover-qmlmodule.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-nover-qmlmodule.html new file mode 100644 index 000000000..68cdf82d4 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test-nover-qmlmodule.html @@ -0,0 +1,23 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="QML Types for the Test module without version."> + <title>Versionless QML Module | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Versionless QML Module</h1> +<p>This module is in <i>Tech Preview</i> state.</p> +<p>This module was introduced in Qt 1.1.</p> +<!-- $$$Test.NoVer-description --> +<div class="descr" id="details"> +</div> +<!-- @@@Test.NoVer --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-test-nover-doctest.html">DocTest</a></p></td><td class="tblDescr"><p>Shadows the type name in QDoc.Test module</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qml-test-nover-typenoversion.html">TypeNoVersion</a></p></td><td class="tblDescr"><p>Another QML type documented in a .cpp file</p></td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.index b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.index new file mode 100644 index 000000000..55637861e --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.index @@ -0,0 +1,238 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE QDOCINDEX> +<INDEX url="" title="A test project for QDoc build artifacts" version="6.2.11" project="Test"> + <namespace name="" status="active" access="public" module="test"> + <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="0" since="Test 0.9" meta="macrowithoutparams" signature="QDOCTEST_MACRO"/> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" brief="A macro with argument x" signature="QDOCTEST_MACRO2(int &x)" groups="testgroup"> + <parameter type="int &" name="x" default=""/> + </function> + <qmlclass name="AbstractParent" qml-module-name="QDoc.Test" fullname="QDoc.Test.AbstractParent" href="qml-qdoc-test-abstractparent.html" status="active" access="public" abstract="true" location="parent.qdoc" since="1.1" documented="true" title="AbstractParent" fulltitle="AbstractParent" subtitle="" brief="Abstract base QML type"> + <function name="name" fullname="QDoc.Test.AbstractParent.name" href="qml-qdoc-test-abstractparent.html#name-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="void"/> + <function name="name" fullname="QDoc.Test.AbstractParent.name" href="qml-qdoc-test-abstractparent.html#name-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="void"> + <parameter type="Child" name="child" default=""/> + <parameter type="" name="name" default=""/> + </function> + <function name="rear" fullname="QDoc.Test.AbstractParent.rear" href="qml-qdoc-test-abstractparent.html#rear-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="void"> + <parameter type="Child" name="child" default=""/> + <parameter type="var" name="method" default="Strict"/> + </function> + <qmlproperty name="children" fullname="QDoc.Test.AbstractParent.children" status="active" access="public" location="parent.qdoc" documented="true" type="list<Child>" attached="false" writable="true" brief="Children of the type"/> + <qmlproperty name="name" fullname="QDoc.Test.AbstractParent.name" status="active" access="public" location="parent.qdoc" documented="true" type="string" attached="false" writable="true" brief="Name of this parent"/> + </qmlclass> + <page name="autolinking.html" href="autolinking.html" status="active" location="classlists.qdoc" documented="true" subtype="page" title="Autolinking" fulltitle="Autolinking" subtitle=""> + <contents name="testqdoc" title="TestQDoc" level="1"/> + <contents name="someprop" title="someProp" level="1"/> + </page> + <page name="cmaketest" href="test-cmaketest-example.html" status="active" location="cmaketest.qdoc" documented="true" subtype="example" title="CMake Example Project" fulltitle="CMake Example Project" subtitle=""> + <page name="cmaketest/main.cpp" href="test-cmaketest-main-cpp.html" status="active" subtype="file" title="" fulltitle="main.cpp Example File" subtitle="cmaketest/main.cpp"/> + <page name="cmaketest/CMakeLists.txt" href="test-cmaketest-cmakelists-txt.html" status="active" subtype="file" title="" fulltitle="CMakeLists.txt Example File" subtitle="cmaketest/CMakeLists.txt"/> + </page> + <qmlclass name="Child" qml-module-name="QDoc.Test" qml-base-type="QDoc.Test::AbstractParent" fullname="QDoc.Test.Child" href="qml-qdoc-test-child.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="Child" fulltitle="Child" subtitle="" brief="A Child inheriting its parent"> + <function name="name" fullname="QDoc.Test.Child.name" href="qml-qdoc-test-child.html#name-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="void"> + <parameter type="Child" name="child" default=""/> + <parameter type="" name="name" default=""/> + </function> + <qmlproperty name="name" fullname="QDoc.Test.Child.name" href="qml-qdoc-test-child.html#name-prop" status="active" access="public" location="parent.qdoc" documented="true" type="string" attached="false" writable="true" brief="Name of this child"/> + </qmlclass> + <page name="classes.html" href="classes.html" status="active" location="unseenclass.qdoc" documented="true" subtype="page" title="Classes" fulltitle="Classes" subtitle=""/> + <namespace name="CrossModuleRef" href="crossmoduleref.html" status="active" access="public" location="testcpp.h" since="3.0" documented="true" module="TestCPP" brief="Namespace that has documented functions in multiple modules"> + <function name="documentMe" fullname="CrossModuleRef::documentMe" href="crossmoduleref.html#documentMe" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void documentMe()"/> + </namespace> + <page name="demos/demo" href="test-demos-demo-example.html" status="active" location="demo.qdoc" documented="true" subtype="example" title="Demo" fulltitle="Demo" subtitle=""> + <page name="demos/demo/demo.cpp" href="test-demos-demo-demo-cpp.html" status="active" subtype="file" title="" fulltitle="demo.cpp Example File" subtitle="demos/demo/demo.cpp"/> + <page name="demos/demo/demo.pro" href="test-demos-demo-demo-pro.html" status="active" subtype="file" title="" fulltitle="demo.pro Example File" subtitle="demos/demo/demo.pro"/> + <page name="demos/demo/dontxclude/CMakeLists.txt" href="test-demos-demo-dontxclude-cmakelists-txt.html" status="active" subtype="file" title="" fulltitle="CMakeLists.txt Example File" subtitle="demos/demo/dontxclude/CMakeLists.txt"/> + </page> + <qmlclass name="DocTest" qml-module-name="QDoc.Test" fullname="QDoc.Test.DocTest" href="qml-qdoc-test-doctest.html" status="active" access="public" location="DocTest.qml" since="QDoc.Test 0.9" documented="true" title="DocTest" fulltitle="DocTest" subtitle="" brief="Represents a doc test case"> + <contents name="introduction" title="Introduction" level="1"/> + <function name="completed" fullname="QDoc.Test.DocTest.completed" href="qml-qdoc-test-doctest.html#completed-signal" status="active" access="public" documented="true" meta="qmlsignal"/> + <function name="fail" fullname="QDoc.Test.DocTest.fail" href="qml-qdoc-test-doctest.html#fail-method" status="active" access="public" location="DocTest.qml" documented="true" since="QDoc.Test 1.0" meta="qmlmethod"> + <parameter type="" name="message" default=""oops""/> + </function> + <function name="fail_hard" fullname="QDoc.Test.DocTest.fail_hard" href="qml-qdoc-test-doctest.html#fail_hard-method" status="active" access="public" documented="true" meta="qmlmethod"> + <parameter type="" name="msg" default=""facepalm""/> + <parameter type="" name="option" default="123"/> + </function> + <function name="foo" fullname="QDoc.Test.DocTest.foo" href="qml-qdoc-test-doctest.html#foo-signal" status="active" access="public" location="DocTest.qml" documented="true" meta="qmlsignal"> + <parameter type="var" name="bar" default=""/> + </function> + <function name="itsHappening" fullname="QDoc.Test.DocTest.itsHappening" href="qml-qdoc-test-doctest.html#itsHappening-signal" status="active" access="public" documented="true" meta="qmlsignal"> + <parameter type="bool" name="really" default=""/> + </function> + <qmlproperty name="active" fullname="QDoc.Test.DocTest.active" href="qml-qdoc-test-doctest.html#active-prop" status="active" access="public" documented="true" type="bool" attached="false" writable="true"/> + <qmlproperty name="name" fullname="QDoc.Test.DocTest.name" href="qml-qdoc-test-doctest.html#name-prop" status="active" access="public" documented="true" type="string" attached="false" writable="true" required="true"/> + </qmlclass> + <qmlclass name="DocTest" qml-module-name="Test.NoVer" fullname="Test.NoVer.DocTest" href="qml-test-nover-doctest.html" status="active" access="public" location="DocTest.qml" since="1.1" documented="true" title="DocTest" fulltitle="DocTest" subtitle="" brief="Shadows the type name in QDoc.Test module"/> + <class name="DontLinkToMe" href="dontlinktome.html" status="ignored" access="public" location="testcpp.h" since="2.0" documented="true" module="TestCPP" brief="Class that does not generate documentation"/> + <page name="demos/hidden" href="test-demos-hidden-example.html" status="active" location="hidden.qdoc" documented="true" subtype="example" title="Hidden Demo" fulltitle="Hidden Demo" subtitle="" brief="Tagged 'broken', does not appear in examples-manifest.xml"/> + <page name="obsolete-classes.html" href="obsolete-classes.html" status="active" location="classlists.qdoc" documented="true" subtype="page" title="Obsolete Classes" fulltitle="Obsolete Classes" subtitle=""> + <contents name="classes-with-obsolete-members" title="Classes with obsolete members" level="1"/> + <contents name="testqdoc" title="TestQDoc" level="2"/> + </page> + <qmlclass name="OldType" qml-module-name="QDoc.Test" fullname="QDoc.Test.OldType" href="qml-qdoc-test-oldtype.html" status="deprecated" access="public" since="1.1" documented="true" title="OldType" fulltitle="OldType" subtitle="" brief="Deprecated old type"/> + <qmlclass name="ProgressBar" qml-module-name="UIComponents" fullname="UIComponents.ProgressBar" href="qml-uicomponents-progressbar.html" status="active" access="public" location="ProgressBar.qml" documented="true" title="ProgressBar" fulltitle="ProgressBar" subtitle="" brief="A component that shows the progress of an event"> + <qmlproperty name="color" fullname="UIComponents.ProgressBar.color" href="qml-uicomponents-progressbar.html#color-prop" status="active" access="public" documented="true" type="color" attached="false" writable="true"/> + <qmlproperty name="maximum" fullname="UIComponents.ProgressBar.maximum" href="qml-uicomponents-progressbar.html#maximum-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true"/> + <qmlproperty name="minimum" fullname="UIComponents.ProgressBar.minimum" href="qml-uicomponents-progressbar.html#minimum-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true"/> + <qmlproperty name="secondColor" fullname="UIComponents.ProgressBar.secondColor" href="qml-uicomponents-progressbar.html#secondColor-prop" status="active" access="public" documented="true" type="color" attached="false" writable="true"/> + <qmlproperty name="value" fullname="UIComponents.ProgressBar.value" href="qml-uicomponents-progressbar.html#value-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true"/> + </qmlclass> + <page name="componentset" href="test-componentset-example.html" status="active" location="examples.qdoc" documented="true" subtype="example" title="QML Documentation Example" fulltitle="QML Documentation Example" subtitle="" brief="Example for documenting QML types"> + <contents name="qml-class" title="QML Class" level="1"/> + <contents name="properties-signals-handlers-and-methods" title="Properties, Signals, Handlers, and Methods" level="1"/> + <contents name="internal-documentation" title="Internal Documentation" level="2"/> + <contents name="qml-types-with-c-implementation" title="QML Types with C++ Implementation" level="1"/> + <page name="componentset/ProgressBar.qml" href="test-componentset-progressbar-qml.html" status="active" subtype="file" title="" fulltitle="ProgressBar.qml Example File" subtitle="componentset/ProgressBar.qml"/> + <page name="componentset/Switch.qml" href="test-componentset-switch-qml.html" status="active" subtype="file" title="" fulltitle="Switch.qml Example File" subtitle="componentset/Switch.qml"/> + <page name="componentset/TabWidget.qml" href="test-componentset-tabwidget-qml.html" status="active" subtype="file" title="" fulltitle="TabWidget.qml Example File" subtitle="componentset/TabWidget.qml"/> + <page name="componentset/componentset.qml" href="test-componentset-componentset-qml.html" status="active" subtype="file" title="" fulltitle="componentset.qml Example File" subtitle="componentset/componentset.qml"/> + <page name="componentset/componentset.pro" href="test-componentset-componentset-pro.html" status="active" subtype="file" title="" fulltitle="componentset.pro Example File" subtitle="componentset/componentset.pro"/> + </page> + <page name="qmlmodules.html" href="qmlmodules.html" status="active" location="modules.qdoc" documented="true" subtype="page" title="QML Modules" fulltitle="QML Modules" subtitle=""> + <contents name="qml-types" title="QML types" level="1"/> + <contents name="qml-value-types" title="QML value types" level="1"/> + </page> + <page name="https://wiki.qt.io/QProperty" href="https://wiki.qt.io/QProperty" status="active" location="properties.qdoc" documented="true" subtype="externalpage" title="QProperty" fulltitle="QProperty" subtitle=""/> + <class name="SeenClass" href="seenclass.html" status="active" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"/> + <qmlclass name="Switch" qml-module-name="UIComponents" fullname="UIComponents.Switch" href="qml-uicomponents-switch.html" status="active" access="public" location="Switch.qml" documented="true" title="Switch" fulltitle="Switch" subtitle="" brief="A component that can be turned on or off"> + <function name="toggle" fullname="UIComponents.Switch.toggle" href="qml-uicomponents-switch.html#toggle-method" status="active" access="public" documented="true" meta="qmlmethod"/> + <qmlproperty name="on" fullname="UIComponents.Switch.on" href="qml-uicomponents-switch.html#on-prop" status="active" access="public" documented="true" type="bool" attached="false" writable="true"/> + </qmlclass> + <qmlclass name="TabWidget" qml-module-name="UIComponents" fullname="UIComponents.TabWidget" href="qml-uicomponents-tabwidget.html" status="active" access="public" location="TabWidget.qml" documented="true" title="TabWidget" fulltitle="TabWidget" subtitle="" brief="A widget that places its children as tabs"> + <contents name="adding-tabs" title="Adding Tabs" level="1"/> + <qmlproperty name="current" fullname="UIComponents.TabWidget.current" href="qml-uicomponents-tabwidget.html#current-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true"/> + <qmlproperty name="sampleReadOnlyProperty" fullname="UIComponents.TabWidget.sampleReadOnlyProperty" href="qml-uicomponents-tabwidget.html#sampleReadOnlyProperty-prop" status="active" access="public" documented="true" type="int" attached="false" writable="false"/> + </qmlclass> + <namespace name="TestQDoc" href="testqdoc.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" module="TestCPP" brief="A namespace"> + <contents name="usage" title="Usage" level="1"/> + <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="0" since="Test 0.9" meta="macrowithoutparams" signature="QDOCTEST_MACRO"/> + <class threadsafety="reentrant" name="Test" fullname="TestQDoc::Test" href="testqdoc-test.html" status="active" access="public" location="testcpp.h" since="1.1" documented="true" groups="cpptypes,testgroup" module="TestCPP" brief="A class in a namespace"> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" brief="A macro with argument x" signature="QDOCTEST_MACRO2(int &x)" groups="testgroup"> + <parameter type="int &" name="x" default=""/> + </function> + <function name="Test" fullname="TestQDoc::Test::Test" href="testqdoc-test.html#Test" status="active" access="public" location="testcpp.h" documented="true" meta="constructor" signature="Test()"/> + <function name="anotherObsoleteMember" fullname="TestQDoc::Test::anotherObsoleteMember" href="testqdoc-test-obsolete.html#anotherObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void anotherObsoleteMember()"/> + <function name="deprecatedMember" fullname="TestQDoc::Test::deprecatedMember" href="testqdoc-test-obsolete.html#deprecatedMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void deprecatedMember()"/> + <function name="funcPtr" fullname="TestQDoc::Test::funcPtr" href="testqdoc-test.html#funcPtr" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void (*)(bool)" signature="void (*)(bool) funcPtr(bool b, const char *s)"> + <parameter type="bool" name="b" default=""/> + <parameter type="const char *" name="s" default=""/> + </function> + <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"/> + <function name="methodWithEmDashInItsDocs" fullname="TestQDoc::Test::methodWithEmDashInItsDocs" href="testqdoc-test.html#methodWithEmDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEmDashInItsDocs()"/> + <function name="methodWithEnDashInItsDocs" fullname="TestQDoc::Test::methodWithEnDashInItsDocs" href="testqdoc-test.html#methodWithEnDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEnDashInItsDocs()"/> + <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void obsoleteMember()"/> + <function name="operator++" fullname="TestQDoc::Test::operator++" href="testqdoc-test-obsolete.html#operator-2b-2b" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator++()"/> + <function name="operator--" fullname="TestQDoc::Test::operator--" href="testqdoc-test-obsolete.html#operator--" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator--()"/> + <function name="operator=" fullname="TestQDoc::Test::operator=" href="testqdoc-test.html#operator-eq" status="active" access="public" location="testcpp.h" documented="true" meta="move-assign" type="TestQDoc::Test &" signature="TestQDoc::Test & operator=(TestQDoc::Test &&other)" groups="testgroup"> + <parameter type="TestQDoc::Test &&" name="other" default=""/> + </function> + <function name="operator==" href="testqdoc-test.html#operator-eq-eq" status="active" access="public" location="testcpp.h" documented="true" related="2" meta="plain" type="bool" signature="bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)"> + <parameter type="const TestQDoc::Test &" name="lhs" default=""/> + <parameter type="const TestQDoc::Test &" name="rhs" default=""/> + </function> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" documented="true" meta="plain" type="void" signature="void overload()"/> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" documented="true" since="Test 1.2" meta="plain" overload="true" overload-number="1" type="void" signature="void overload(bool b)"> + <parameter type="bool" name="b" default=""/> + </function> + <function name="someFunction" fullname="TestQDoc::Test::someFunction" href="testqdoc-test.html#someFunction" status="active" access="public" location="testcpp.h" documented="true" since="Test 1.0" meta="plain" type="int" signature="int someFunction(int, int v)"> + <parameter type="int" name="" default=""/> + <parameter type="int" name="v" default="0"/> + </function> + <function name="someFunctionDefaultArg" fullname="TestQDoc::Test::someFunctionDefaultArg" href="testqdoc-test.html#someFunctionDefaultArg" threadsafety="non-reentrant" status="active" access="public" location="testcpp.h" documented="true" since="2.0" meta="plain" const="true" type="void" signature="void someFunctionDefaultArg(int i, bool b) const" groups="testgroup"> + <parameter type="int" name="i" default=""/> + <parameter type="bool" name="b" default="false"/> + </function> + <function name="virtualFun" fullname="TestQDoc::Test::virtualFun" href="testqdoc-test.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" type="void" signature="void virtualFun()"/> + <typedef name="SomeType" fullname="TestQDoc::Test::SomeType" href="testqdoc-test.html#SomeType-typedef" status="active" access="public" location="testcpp.h" documented="true"/> + </class> + <class name="TestDerived" fullname="TestQDoc::TestDerived" href="testqdoc-testderived.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" bases="TestQDoc::Test" module="TestCPP" brief="A class in a namespace, derived from Test"> + <function name="bindableProp" fullname="TestQDoc::TestDerived::bindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="bindableProp" type="QBindable<QString>" signature="QBindable<QString> bindableProp()"/> + <function name="bindablePropChanged" fullname="TestQDoc::TestDerived::bindablePropChanged" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="signal" associated-property="bindableProp" type="void" signature="void bindablePropChanged()"/> + <function name="boolProp" fullname="TestQDoc::TestDerived::boolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="boolProp" type="bool" signature="bool boolProp()"/> + <function name="boolPropChanged" fullname="TestQDoc::TestDerived::boolPropChanged" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="signal" associated-property="boolProp" type="void" signature="void boolPropChanged()"/> + <function name="emitSomething" fullname="TestQDoc::TestDerived::emitSomething" href="testqdoc-testderived.html#emitSomething" status="active" access="public" location="testcpp.h" documented="true" meta="signal" type="void" signature="void emitSomething()"/> + <function name="getInt" fullname="TestQDoc::TestDerived::getInt" href="testqdoc-testderived.html#intProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="intProp" type="int *" signature="int * getInt()"/> + <function name="id" fullname="TestQDoc::TestDerived::id" href="testqdoc-testderived.html#id" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="int" signature="int id() override"/> + <function name="invokeMe" fullname="TestQDoc::TestDerived::invokeMe" href="testqdoc-testderived.html#invokeMe" status="active" access="public" location="testcpp.h" documented="true" meta="plain" const="true" type="void" brief="Something invokable" signature="void invokeMe() const"/> + <function name="name" fullname="TestQDoc::TestDerived::name" href="testqdoc-testderived.html#name-prop" status="active" access="public" location="testcpp.h" meta="plain" const="true" associated-property="name" type="const QString *" signature="const QString * name() const"/> + <function name="resetBoolProp" fullname="TestQDoc::TestDerived::resetBoolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="boolProp" type="void" signature="void resetBoolProp()"/> + <function name="setBindableProp" fullname="TestQDoc::TestDerived::setBindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="bindableProp" type="void" signature="void setBindableProp(const QString &s)"> + <parameter type="const QString &" name="s" default=""/> + </function> + <function name="setBoolProp" fullname="TestQDoc::TestDerived::setBoolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="boolProp" type="void" signature="void setBoolProp(bool b)"> + <parameter type="bool" name="b" default=""/> + </function> + <function name="someProp" fullname="TestQDoc::TestDerived::someProp" href="testqdoc-testderived.html#someProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="someProp" type="const QString &" signature="const QString & someProp()"/> + <function name="someValue" fullname="TestQDoc::TestDerived::someValue" href="testqdoc-testderived.html#someValue" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::TestDerived::NotTypedef" signature="TestQDoc::TestDerived::NotTypedef someValue()"/> + <function name="staticObsoleteMember" fullname="TestQDoc::TestDerived::staticObsoleteMember" href="testqdoc-testderived-obsolete.html#staticObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" static="true" type="void" signature="void staticObsoleteMember()"/> + <function name="virtualFun" fullname="TestQDoc::TestDerived::virtualFun" href="testqdoc-testderived.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="void" signature="void virtualFun() override"/> + <typedef name="DerivedType" fullname="TestQDoc::TestDerived::DerivedType" href="testqdoc-testderived.html#DerivedType-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="Test::SomeType"/> + <typedef name="NotTypedef" fullname="TestQDoc::TestDerived::NotTypedef" href="testqdoc-testderived.html#NotTypedef-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="int"/> + <property name="bindableProp" fullname="TestQDoc::TestDerived::bindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" documented="true" bindable="true"> + <getter name="bindableProp"/> + <setter name="setBindableProp"/> + <notifier name="bindablePropChanged"/> + </property> + <property name="boolProp" fullname="TestQDoc::TestDerived::boolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" documented="true"> + <getter name="boolProp"/> + <setter name="setBoolProp"/> + <resetter name="resetBoolProp"/> + <notifier name="boolPropChanged"/> + </property> + <property name="intProp" fullname="TestQDoc::TestDerived::intProp" href="testqdoc-testderived.html#intProp-prop" status="active" access="public" location="testcpp.h" documented="true" writable="false"> + <getter name="getInt"/> + </property> + <property name="name" fullname="TestQDoc::TestDerived::name" href="testqdoc-testderived.html#name-prop" status="active" access="public" location="testcpp.h" documented="true" writable="false" brief="This property holds a name"> + <getter name="name"/> + </property> + <property name="someProp" fullname="TestQDoc::TestDerived::someProp" href="testqdoc-testderived.html#someProp-prop" status="active" access="public" location="testcpp.h" documented="true" bindable="true" writable="false"> + <getter name="someProp"/> + </property> + </class> + </namespace> + <qmlclass name="TheType" qml-module-name="TheModule" fullname="TheModule.TheType" href="qml-themodule-thetype.html" status="active" access="public" location="properties.qdoc" documented="true" title="TheType" fulltitle="TheType" subtitle=""> + <qmlproperty name="name" fullname="TheModule.TheType.name" href="qml-themodule-thetype.html#name-prop" status="active" access="public" location="properties.qdoc" documented="true" type="string" attached="false" writable="false" brief="Read-only status of this property is resolved from Q_PROPERTY"/> + </qmlclass> + <qmlclass name="Type" qml-module-name="QDoc.Test" fullname="QDoc.Test.Type" href="qml-qdoc-test-type.html" status="active" access="public" since="1.1" documented="true" title="Type" fulltitle="Type" subtitle="" brief="A QML type documented in a .cpp file"> + <function name="completed" fullname="QDoc.Test.Type.completed" href="qml-qdoc-test-type.html#completed-signal" status="active" access="public" documented="true" meta="qmlsignal"> + <parameter type="int" name="status" default=""/> + </function> + <function name="configured" fullname="QDoc.Test.Type.configured" href="qml-qdoc-test-type.html#configured-signal" status="active" access="public" documented="true" meta="qmlsignal"/> + <function name="copy" fullname="QDoc.Test.Type.copy" href="qml-qdoc-test-type.html#copy-method" status="active" access="public" documented="true" meta="qmlmethod" type="Type"> + <parameter type="" name="a" default=""/> + </function> + <function name="deprecatedMethod" fullname="QDoc.Test.Type.deprecatedMethod" href="qml-qdoc-test-type-obsolete.html#deprecatedMethod-method" status="deprecated" access="public" documented="true" meta="qmlmethod"/> + <function name="disable" fullname="QDoc.Test.Type.disable" href="qml-qdoc-test-type.html#disable-method" status="active" access="public" documented="true" meta="qmlmethod"/> + <function name="enable" fullname="QDoc.Test.Type.enable" href="qml-qdoc-test-type.html#enable-method" status="active" access="public" documented="true" meta="qmlmethod"/> + <function name="futureDeprecated" fullname="QDoc.Test.Type.futureDeprecated" href="qml-qdoc-test-type.html#futureDeprecated-method" status="active" access="public" documented="true" meta="qmlmethod"/> + <function name="group.created" fullname="QDoc.Test.Type.group.created" href="qml-qdoc-test-type.html#group.created-signal" status="active" access="public" documented="true" meta="qmlsignal"/> + <qmlproperty name="fifth" fullname="QDoc.Test.Type.fifth" href="qml-qdoc-test-type.html#fifth-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A group of properties sharing a documentation comment"/> + <qmlproperty name="fourth" fullname="QDoc.Test.Type.fourth" href="qml-qdoc-test-type.html#fourth-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A group of properties sharing a documentation comment"/> + <qmlproperty name="group.first" fullname="QDoc.Test.Type.group.first" href="qml-qdoc-test-type.html#group.first-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A property group"/> + <qmlproperty name="group.second" fullname="QDoc.Test.Type.group.second" href="qml-qdoc-test-type.html#group.second-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A property group"/> + <qmlproperty name="group.third" fullname="QDoc.Test.Type.group.third" href="qml-qdoc-test-type.html#group.third-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A property group"/> + <qmlproperty name="id" fullname="QDoc.Test.Type.id" href="qml-qdoc-test-type.html#id-prop" status="active" access="public" documented="true" type="int" attached="false" writable="false" brief="A read-only property"/> + <qmlproperty name="name" fullname="QDoc.Test.Type.name" href="qml-qdoc-test-type.html#name-prop" status="active" access="public" documented="true" type="string" attached="false" writable="true" required="true" brief="Name of the Test"/> + <qmlproperty name="type" fullname="QDoc.Test.Type.type" href="qml-qdoc-test-type.html#type-attached-prop" status="active" access="public" documented="true" type="enumeration" attached="true" writable="true"/> + <qmlproperty name="group" fullname="QDoc.Test.Type.group" href="qml-qdoc-test-type.html#group-prop" status="active" access="public" documented="true"/> + </qmlclass> + <qmlclass name="TypeNoVersion" qml-module-name="Test.NoVer" fullname="Test.NoVer.TypeNoVersion" href="qml-test-nover-typenoversion.html" status="active" access="public" since="1.1" documented="true" title="TypeNoVersion" fulltitle="TypeNoVersion" subtitle="" brief="Another QML type documented in a .cpp file"/> + <class name="UnseenClass" href="unseenclass.html" status="ignored" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"/> + <qmlclass name="YetAnotherChild" qml-module-name="QDoc.Test" qml-base-type="QDoc.Test::InternParent" fullname="QDoc.Test.YetAnotherChild" href="qml-qdoc-test-yetanotherchild.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="YetAnotherChild" fulltitle="YetAnotherChild" subtitle="" brief="A type inheriting from internal abstract parent"/> + <qmlvaluetype name="int" qml-module-name="QDoc.Test" fullname="QDoc.Test.int" href="qml-int.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="int" fulltitle="int" subtitle="" brief="An integer value type"> + <function name="abs" fullname="QDoc.Test.int.abs" href="qml-int.html#abs-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="int"/> + </qmlvaluetype> + <page name="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command" href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command" status="active" location="classlists.qdoc" documented="true" subtype="externalpage" title="reentrant" fulltitle="reentrant" subtitle=""/> + <group name="cpptypes" href="cpptypes.html" status="active" location="classlists.qdoc" documented="true" seen="true" title="Test C++ Types"/> + <group name="testgroup" href="testgroup.html" status="internal" seen="false" title=""/> + <module name="TestCPP" href="testcpp-module.html" status="active" since="2.0" documented="true" seen="true" title="QDoc Test C++ Classes" brief="A test module page"> + <contents name="linking-to-function-like-things" title="Linking to function-like things" level="1"/> + <contents name="section" title="section()" level="2"/> + </module> + <qmlmodule name="QDoc.Test" qml-module-name="QDoc.Test" qml-module-version="1.1" href="qdoc-test-qmlmodule.html" status="preliminary" since="1.1" documented="true" seen="true" title="QDoc.Test QML Module" brief="QML Types for the Test module"/> + <qmlmodule name="Test.Empty" qml-module-name="Test.Empty" qml-module-version="1.0" href="test-empty-qmlmodule.html" status="active" documented="true" seen="true" title="No QML Types Here" brief="A QML module with no member types"/> + <qmlmodule name="Test.NoVer" qml-module-name="Test.NoVer" href="test-nover-qmlmodule.html" status="active" since="1.1" documented="true" seen="true" title="Versionless QML Module" brief="QML Types for the Test module without version"/> + <qmlmodule name="TheModule" qml-module-name="TheModule" href="themodule-qmlmodule.html" status="active" location="properties.qdoc" documented="true" seen="true" title=""/> + <qmlmodule name="UIComponents" qml-module-name="UIComponents" qml-module-version="1.0" href="uicomponents-qmlmodule.html" status="active" location="examples.qdoc" documented="true" seen="true" title="UI Components" brief="Basic set of UI components"/> + </namespace> +</INDEX> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.qhp b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.qhp new file mode 100644 index 000000000..ba54e85ea --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.qhp @@ -0,0 +1,260 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QtHelpProject version="1.0"> + <namespace>org.qt-project.test.001</namespace> + <virtualFolder>test</virtualFolder> + <metaData name="version" value="6.2.11"/> + <filterSection> + <toc> + <section ref="uicomponents-qmlmodule.html" title="UI Components"> + <section ref="uicomponents-qmlmodule.html" title="Test"> + <section ref="themodule-qmlmodule.html" title=""/> + <section ref="autolinking.html" title="Autolinking"/> + <section ref="test-cmaketest-example.html" title="CMake Example Project"/> + <section ref="classes.html" title="Classes"/> + <section ref="test-demos-demo-example.html" title="Demo"/> + <section ref="test-demos-hidden-example.html" title="Hidden Demo"/> + <section ref="test-empty-qmlmodule.html" title="No QML Types Here"/> + <section ref="obsolete-classes.html" title="Obsolete Classes"/> + <section ref="testcpp-module.html" title="QDoc Test C++ Classes"/> + <section ref="qdoc-test-qmlmodule.html" title="QDoc.Test QML Module"/> + <section ref="test-componentset-example.html" title="QML Documentation Example"/> + <section ref="qmlmodules.html" title="QML Modules"/> + <section ref="uicomponents-qmlmodule.html" title="UI Components"/> + <section ref="test-nover-qmlmodule.html" title="Versionless QML Module"/> + </section> + <section ref="testcpp-module.html" title="Classes"> + <section ref="crossmoduleref.html" title="CrossModuleRef"/> + <section ref="seenclass.html" title="SeenClass Class Reference"/> + <section ref="testqdoc.html" title="TestQDoc"/> + <section ref="testqdoc-test.html" title="TestQDoc::Test Class Reference"> + <section ref="testqdoc-test-members.html" title="List of all members"/> + <section ref="testqdoc-test-obsolete.html" title="Obsolete members"/> + </section> + <section ref="testqdoc-testderived.html" title="TestQDoc::TestDerived Class Reference"> + <section ref="testqdoc-testderived-members.html" title="List of all members"/> + <section ref="testqdoc-testderived-obsolete.html" title="Obsolete members"/> + </section> + </section> + <section ref="uicomponents-qmlmodule.html" title="QML Types"> + <section ref="qml-qdoc-test-abstractparent.html" title="AbstractParent Type Reference"> + <section ref="qml-qdoc-test-abstractparent-members.html" title="List of all members"/> + </section> + <section ref="qml-qdoc-test-child.html" title="Child Type Reference"> + <section ref="qml-qdoc-test-child-members.html" title="List of all members"/> + </section> + <section ref="qml-qdoc-test-doctest.html" title="DocTest Type Reference"> + <section ref="qml-qdoc-test-doctest-members.html" title="List of all members"/> + </section> + <section ref="qml-qdoc-test-oldtype.html" title="OldType Type Reference"> + <section ref="qml-qdoc-test-oldtype-members.html" title="List of all members"/> + </section> + <section ref="qml-qdoc-test-type.html" title="Type Type Reference"> + <section ref="qml-qdoc-test-type-members.html" title="List of all members"/> + <section ref="qml-qdoc-test-type-obsolete.html" title="Obsolete members"/> + </section> + <section ref="qml-qdoc-test-yetanotherchild.html" title="YetAnotherChild Type Reference"> + <section ref="qml-qdoc-test-yetanotherchild-members.html" title="List of all members"/> + </section> + <section ref="qml-int.html" title="int Type Reference"/> + <section ref="qml-uicomponents-progressbar.html" title="ProgressBar Type Reference"> + <section ref="qml-uicomponents-progressbar-members.html" title="List of all members"/> + </section> + <section ref="qml-uicomponents-switch.html" title="Switch Type Reference"> + <section ref="qml-uicomponents-switch-members.html" title="List of all members"/> + </section> + <section ref="qml-uicomponents-tabwidget.html" title="TabWidget Type Reference"> + <section ref="qml-uicomponents-tabwidget-members.html" title="List of all members"/> + </section> + </section> + </section> + </toc> + <keywords> + <keyword name="AbstractParent" id="QML.AbstractParent" ref="qml-qdoc-test-abstractparent.html"/> + <keyword name="AbstractParent" id="QML.QDoc.Test1.AbstractParent" ref="qml-qdoc-test-abstractparent.html"/> + <keyword name="Autolinking" id="Autolinking" ref="autolinking.html"/> + <keyword name="Child" id="QML.Child" ref="qml-qdoc-test-child.html"/> + <keyword name="Child" id="QML.QDoc.Test1.Child" ref="qml-qdoc-test-child.html"/> + <keyword name="Classes" id="Classes" ref="classes.html"/> + <keyword name="CrossModuleRef" id="CrossModuleRef" ref="crossmoduleref.html"/> + <keyword name="DocTest" id="QML.DocTest" ref="qml-qdoc-test-doctest.html"/> + <keyword name="DocTest" id="QML.QDoc.Test1.DocTest" ref="qml-qdoc-test-doctest.html"/> + <keyword name="DocTest" id="QML.DocTest" ref="qml-test-nover-doctest.html"/> + <keyword name="DocTest" id="QML.Test.NoVer.DocTest" ref="qml-test-nover-doctest.html"/> + <keyword name="Obsolete Classes" id="Obsolete Classes" ref="obsolete-classes.html"/> + <keyword name="OldType" id="QML.OldType" ref="qml-qdoc-test-oldtype.html"/> + <keyword name="OldType" id="QML.QDoc.Test1.OldType" ref="qml-qdoc-test-oldtype.html"/> + <keyword name="ProgressBar" id="QML.ProgressBar" ref="qml-uicomponents-progressbar.html"/> + <keyword name="ProgressBar" id="QML.UIComponents1.ProgressBar" ref="qml-uicomponents-progressbar.html"/> + <keyword name="QDOCTEST_MACRO" id="QDOCTEST_MACRO" ref="testqdoc.html#QDOCTEST_MACRO"/> + <keyword name="QDOCTEST_MACRO2" id="QDOCTEST_MACRO2" ref="testqdoc-test.html#QDOCTEST_MACRO2"/> + <keyword name="QDoc Test C++ Classes" id="QDoc Test C++ Classes" ref="testcpp-module.html"/> + <keyword name="QDoc.Test" id="QML.Test.QDoc" ref="qdoc-test-qmlmodule.html"/> + <keyword name="QML Modules" id="QML Modules" ref="qmlmodules.html"/> + <keyword name="SeenClass" id="SeenClass" ref="seenclass.html"/> + <keyword name="Switch" id="QML.Switch" ref="qml-uicomponents-switch.html"/> + <keyword name="Switch" id="QML.UIComponents1.Switch" ref="qml-uicomponents-switch.html"/> + <keyword name="TabWidget" id="QML.TabWidget" ref="qml-uicomponents-tabwidget.html"/> + <keyword name="TabWidget" id="QML.UIComponents1.TabWidget" ref="qml-uicomponents-tabwidget.html"/> + <keyword name="Test" id="TestQDoc::Test" ref="testqdoc-test.html"/> + <keyword name="Test C++ Types" id="Test C++ Types" ref="cpptypes.html"/> + <keyword name="Test.Empty" id="QML.Empty.Test" ref="test-empty-qmlmodule.html"/> + <keyword name="Test.NoVer" id="QML.NoVer.Test" ref="test-nover-qmlmodule.html"/> + <keyword name="Test::SomeType" id="Test::SomeType" ref="testqdoc-test.html#SomeType-typedef"/> + <keyword name="TestDerived" id="TestQDoc::TestDerived" ref="testqdoc-testderived.html"/> + <keyword name="TestDerived::DerivedType" id="TestDerived::DerivedType" ref="testqdoc-testderived.html#DerivedType-typedef"/> + <keyword name="TestDerived::NotTypedef" id="TestDerived::NotTypedef" ref="testqdoc-testderived.html#NotTypedef-typedef"/> + <keyword name="TestQDoc" id="TestQDoc" ref="testqdoc.html"/> + <keyword name="TheType" id="QML.TheType" ref="qml-themodule-thetype.html"/> + <keyword name="TheType" id="QML.TheModule.TheType" ref="qml-themodule-thetype.html"/> + <keyword name="Type" id="QML.Type" ref="qml-qdoc-test-type.html"/> + <keyword name="Type" id="QML.QDoc.Test1.Type" ref="qml-qdoc-test-type.html"/> + <keyword name="TypeNoVersion" id="QML.TypeNoVersion" ref="qml-test-nover-typenoversion.html"/> + <keyword name="TypeNoVersion" id="QML.Test.NoVer.TypeNoVersion" ref="qml-test-nover-typenoversion.html"/> + <keyword name="UIComponents" id="QML.UIComponents" ref="uicomponents-qmlmodule.html"/> + <keyword name="YetAnotherChild" id="QML.YetAnotherChild" ref="qml-qdoc-test-yetanotherchild.html"/> + <keyword name="YetAnotherChild" id="QML.QDoc.Test1.YetAnotherChild" ref="qml-qdoc-test-yetanotherchild.html"/> + <keyword name="abs" id="int::abs" ref="qml-int.html#abs-method"/> + <keyword name="active" id="DocTest::active" ref="qml-qdoc-test-doctest.html#active-prop"/> + <keyword name="anotherObsoleteMember" id="Test::anotherObsoleteMember" ref="testqdoc-test-obsolete.html#anotherObsoleteMember"/> + <keyword name="bindableProp" id="TestDerived::bindableProp" ref="testqdoc-testderived.html#bindableProp-prop"/> + <keyword name="bindableProp" id="TestDerived::bindableProp" ref="testqdoc-testderived.html#bindableProp-prop"/> + <keyword name="bindablePropChanged" id="TestDerived::bindablePropChanged" ref="testqdoc-testderived.html#bindableProp-prop"/> + <keyword name="boolProp" id="TestDerived::boolProp" ref="testqdoc-testderived.html#boolProp-prop"/> + <keyword name="boolProp" id="TestDerived::boolProp" ref="testqdoc-testderived.html#boolProp-prop"/> + <keyword name="boolPropChanged" id="TestDerived::boolPropChanged" ref="testqdoc-testderived.html#boolProp-prop"/> + <keyword name="children" id="AbstractParent::children" ref="qml-qdoc-test-abstractparent.html#children-prop"/> + <keyword name="color" id="ProgressBar::color" ref="qml-uicomponents-progressbar.html#color-prop"/> + <keyword name="completed" id="DocTest::completed" ref="qml-qdoc-test-doctest.html#completed-signal"/> + <keyword name="completed" id="Type::completed" ref="qml-qdoc-test-type.html#completed-signal"/> + <keyword name="configured" id="Type::configured" ref="qml-qdoc-test-type.html#configured-signal"/> + <keyword name="copy" id="Type::copy" ref="qml-qdoc-test-type.html#copy-method"/> + <keyword name="current" id="TabWidget::current" ref="qml-uicomponents-tabwidget.html#current-prop"/> + <keyword name="deprecatedMember" id="Test::deprecatedMember" ref="testqdoc-test-obsolete.html#deprecatedMember"/> + <keyword name="deprecatedMethod" id="Type::deprecatedMethod" ref="qml-qdoc-test-type-obsolete.html#deprecatedMethod-method"/> + <keyword name="disable" id="Type::disable" ref="qml-qdoc-test-type.html#disable-method"/> + <keyword name="documentMe" id="CrossModuleRef::documentMe" ref="crossmoduleref.html#documentMe"/> + <keyword name="emitSomething" id="TestDerived::emitSomething" ref="testqdoc-testderived.html#emitSomething"/> + <keyword name="enable" id="Type::enable" ref="qml-qdoc-test-type.html#enable-method"/> + <keyword name="fail" id="DocTest::fail" ref="qml-qdoc-test-doctest.html#fail-method"/> + <keyword name="fail_hard" id="DocTest::fail_hard" ref="qml-qdoc-test-doctest.html#fail_hard-method"/> + <keyword name="fifth" id="Type::fifth" ref="qml-qdoc-test-type.html#fifth-prop"/> + <keyword name="foo" id="DocTest::foo" ref="qml-qdoc-test-doctest.html#foo-signal"/> + <keyword name="fourth" id="Type::fourth" ref="qml-qdoc-test-type.html#fourth-prop"/> + <keyword name="funcPtr" id="Test::funcPtr" ref="testqdoc-test.html#funcPtr"/> + <keyword name="futureDeprecated" id="Type::futureDeprecated" ref="qml-qdoc-test-type.html#futureDeprecated-method"/> + <keyword name="getInt" id="TestDerived::getInt" ref="testqdoc-testderived.html#intProp-prop"/> + <keyword name="group.created" id="Type::group.created" ref="qml-qdoc-test-type.html#group.created-signal"/> + <keyword name="group.first" id="Type::group.first" ref="qml-qdoc-test-type.html#group.first-prop"/> + <keyword name="group.second" id="Type::group.second" ref="qml-qdoc-test-type.html#group.second-prop"/> + <keyword name="group.third" id="Type::group.third" ref="qml-qdoc-test-type.html#group.third-prop"/> + <keyword name="id" id="Type::id" ref="qml-qdoc-test-type.html#id-prop"/> + <keyword name="id" id="TestDerived::id" ref="testqdoc-testderived.html#id"/> + <keyword name="inlineFunction" id="Test::inlineFunction" ref="testqdoc-test.html#inlineFunction"/> + <keyword name="int" id="QML.int" ref="qml-int.html"/> + <keyword name="int" id="QML.QDoc.Test1.int" ref="qml-int.html"/> + <keyword name="intProp" id="TestDerived::intProp" ref="testqdoc-testderived.html#intProp-prop"/> + <keyword name="invokeMe" id="TestDerived::invokeMe" ref="testqdoc-testderived.html#invokeMe"/> + <keyword name="itsHappening" id="DocTest::itsHappening" ref="qml-qdoc-test-doctest.html#itsHappening-signal"/> + <keyword name="maximum" id="ProgressBar::maximum" ref="qml-uicomponents-progressbar.html#maximum-prop"/> + <keyword name="methodWithEmDashInItsDocs" id="Test::methodWithEmDashInItsDocs" ref="testqdoc-test.html#methodWithEmDashInItsDocs"/> + <keyword name="methodWithEnDashInItsDocs" id="Test::methodWithEnDashInItsDocs" ref="testqdoc-test.html#methodWithEnDashInItsDocs"/> + <keyword name="minimum" id="ProgressBar::minimum" ref="qml-uicomponents-progressbar.html#minimum-prop"/> + <keyword name="name" id="AbstractParent::name" ref="qml-qdoc-test-abstractparent.html#name-method"/> + <keyword name="name" id="AbstractParent::name" ref="qml-qdoc-test-abstractparent.html#name-prop"/> + <keyword name="name" id="Child::name" ref="qml-qdoc-test-child.html#name-method"/> + <keyword name="name" id="Child::name" ref="qml-qdoc-test-child.html#name-prop"/> + <keyword name="name" id="DocTest::name" ref="qml-qdoc-test-doctest.html#name-prop"/> + <keyword name="name" id="Type::name" ref="qml-qdoc-test-type.html#name-prop"/> + <keyword name="name" id="TheType::name" ref="qml-themodule-thetype.html#name-prop"/> + <keyword name="name" id="TestDerived::name" ref="testqdoc-testderived.html#name-prop"/> + <keyword name="name" id="TestDerived::name" ref="testqdoc-testderived.html#name-prop"/> + <keyword name="obsoleteMember" id="Test::obsoleteMember" ref="testqdoc-test-obsolete.html#obsoleteMember"/> + <keyword name="on" id="Switch::on" ref="qml-uicomponents-switch.html#on-prop"/> + <keyword name="operator++" id="Test::operator++" ref="testqdoc-test-obsolete.html#operator-2b-2b"/> + <keyword name="operator--" id="Test::operator--" ref="testqdoc-test-obsolete.html#operator--"/> + <keyword name="operator=" id="Test::operator=" ref="testqdoc-test.html#operator-eq"/> + <keyword name="operator==" id="operator==" ref="testqdoc-test.html#operator-eq-eq"/> + <keyword name="overload" id="Test::overload" ref="testqdoc-test.html#overload"/> + <keyword name="rear" id="AbstractParent::rear" ref="qml-qdoc-test-abstractparent.html#rear-method"/> + <keyword name="resetBoolProp" id="TestDerived::resetBoolProp" ref="testqdoc-testderived.html#boolProp-prop"/> + <keyword name="sampleReadOnlyProperty" id="TabWidget::sampleReadOnlyProperty" ref="qml-uicomponents-tabwidget.html#sampleReadOnlyProperty-prop"/> + <keyword name="secondColor" id="ProgressBar::secondColor" ref="qml-uicomponents-progressbar.html#secondColor-prop"/> + <keyword name="setBindableProp" id="TestDerived::setBindableProp" ref="testqdoc-testderived.html#bindableProp-prop"/> + <keyword name="setBoolProp" id="TestDerived::setBoolProp" ref="testqdoc-testderived.html#boolProp-prop"/> + <keyword name="someFunction" id="Test::someFunction" ref="testqdoc-test.html#someFunction"/> + <keyword name="someFunctionDefaultArg" id="Test::someFunctionDefaultArg" ref="testqdoc-test.html#someFunctionDefaultArg"/> + <keyword name="someProp" id="TestDerived::someProp" ref="testqdoc-testderived.html#someProp-prop"/> + <keyword name="someProp" id="TestDerived::someProp" ref="testqdoc-testderived.html#someProp-prop"/> + <keyword name="someValue" id="TestDerived::someValue" ref="testqdoc-testderived.html#someValue"/> + <keyword name="staticObsoleteMember" id="TestDerived::staticObsoleteMember" ref="testqdoc-testderived-obsolete.html#staticObsoleteMember"/> + <keyword name="toggle" id="Switch::toggle" ref="qml-uicomponents-switch.html#toggle-method"/> + <keyword name="type" id="Type::type" ref="qml-qdoc-test-type.html#type-attached-prop"/> + <keyword name="value" id="ProgressBar::value" ref="qml-uicomponents-progressbar.html#value-prop"/> + <keyword name="virtualFun" id="Test::virtualFun" ref="testqdoc-test.html#virtualFun"/> + <keyword name="virtualFun" id="TestDerived::virtualFun" ref="testqdoc-testderived.html#virtualFun"/> + </keywords> + <files> + <file>autolinking.html</file> + <file>classes.html</file> + <file>cpptypes.html</file> + <file>crossmoduleref.html</file> + <file>images/leonardo-da-vinci.png</file> + <file>obsolete-classes.html</file> + <file>qdoc-test-qmlmodule.html</file> + <file>qml-int.html</file> + <file>qml-qdoc-test-abstractparent-members.html</file> + <file>qml-qdoc-test-abstractparent.html</file> + <file>qml-qdoc-test-child-members.html</file> + <file>qml-qdoc-test-child.html</file> + <file>qml-qdoc-test-doctest-members.html</file> + <file>qml-qdoc-test-doctest.html</file> + <file>qml-qdoc-test-oldtype-members.html</file> + <file>qml-qdoc-test-oldtype.html</file> + <file>qml-qdoc-test-type-members.html</file> + <file>qml-qdoc-test-type-obsolete.html</file> + <file>qml-qdoc-test-type.html</file> + <file>qml-qdoc-test-yetanotherchild-members.html</file> + <file>qml-qdoc-test-yetanotherchild.html</file> + <file>qml-test-nover-doctest-members.html</file> + <file>qml-test-nover-doctest.html</file> + <file>qml-test-nover-typenoversion-members.html</file> + <file>qml-test-nover-typenoversion.html</file> + <file>qml-themodule-thetype-members.html</file> + <file>qml-themodule-thetype.html</file> + <file>qml-uicomponents-progressbar-members.html</file> + <file>qml-uicomponents-progressbar.html</file> + <file>qml-uicomponents-switch-members.html</file> + <file>qml-uicomponents-switch.html</file> + <file>qml-uicomponents-tabwidget-members.html</file> + <file>qml-uicomponents-tabwidget.html</file> + <file>qmlmodules.html</file> + <file>seenclass.html</file> + <file>test-cmaketest-cmakelists-txt.html</file> + <file>test-cmaketest-example.html</file> + <file>test-cmaketest-main-cpp.html</file> + <file>test-componentset-componentset-pro.html</file> + <file>test-componentset-componentset-qml.html</file> + <file>test-componentset-example.html</file> + <file>test-componentset-progressbar-qml.html</file> + <file>test-componentset-switch-qml.html</file> + <file>test-componentset-tabwidget-qml.html</file> + <file>test-demos-demo-demo-cpp.html</file> + <file>test-demos-demo-demo-pro.html</file> + <file>test-demos-demo-dontxclude-cmakelists-txt.html</file> + <file>test-demos-demo-example.html</file> + <file>test-demos-hidden-example.html</file> + <file>test-empty-qmlmodule.html</file> + <file>test-nover-qmlmodule.html</file> + <file>testcpp-module.html</file> + <file>testqdoc-test-members.html</file> + <file>testqdoc-test-obsolete.html</file> + <file>testqdoc-test.html</file> + <file>testqdoc-testderived-members.html</file> + <file>testqdoc-testderived-obsolete.html</file> + <file>testqdoc-testderived.html</file> + <file>testqdoc.html</file> + <file>themodule-qmlmodule.html</file> + <file>uicomponents-qmlmodule.html</file> + </files> + </filterSection> +</QtHelpProject> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testcpp-module.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testcpp-module.html new file mode 100644 index 000000000..828bfd508 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testcpp-module.html @@ -0,0 +1,60 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A test module page."> + <title>QDoc Test C++ Classes | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#namespaces">Namespaces</a></li> +<li class="level1"><a href="#classes">Classes</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#linking-to-function-like-things">Linking to function-like things</a></li> +<li class="level3"><a href="#section">section()</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">QDoc Test C++ Classes</h1> +<!-- $$$TestCPP-brief --> +<p>A test module page. <a href="#details">More...</a></p> +<!-- @@@TestCPP --> +<p>This module was introduced in Qt 2.0.</p> +<h2 id="namespaces">Namespaces</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="crossmoduleref.html">CrossModuleRef</a></p></td><td class="tblDescr"><p>Namespace that has documented functions in multiple modules</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="testqdoc.html">TestQDoc</a></p></td><td class="tblDescr"><p>A namespace</p></td></tr> +</table></div> +<h2 id="classes">Classes</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="seenclass.html">SeenClass</a></p></td><td class="tblDescr"><p>A public but undocumented class</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-test.html">TestQDoc::Test</a></p></td><td class="tblDescr"><p>A class in a namespace</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p></td><td class="tblDescr"><p>A class in a namespace, derived from Test</p></td></tr> +</table></div> +<!-- $$$TestCPP-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<div class="admonition note"> +<p><b>Note: </b>This is just a test. /* Look, Ma! {I'm made of arguments!} */</p> +</div> +<p><b>This module was introduced in version 5.15.</b></p> +<p>1.0</p> +<h3 id="linking-to-function-like-things">Linking to function-like things</h3> +<ul> +<li><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a>()</li> +<li><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a>()</li> +<li><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a>(int &x)</li> +<li><a href="testcpp-module.html#section" translate="no">section()</a></li> +<li><a href="testcpp-module.html#section" translate="no">section() is a section title</a></li> +<li><a href="testqdoc-test.html#Test" translate="no">open( parenthesis</a></li> +<li><a href="https://en.cppreference.com/w/cpp/utility/move">C++11 added std::move(T&& t)</a></li> +</ul> +<h4 id="section">section()</h4> +</div> +<!-- @@@TestCPP --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test-members.html new file mode 100644 index 000000000..3b34571c7 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test-members.html @@ -0,0 +1,30 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace."> + <title>List of All Members for Test | Test 6.2.11</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>Test</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for Test</h1> +<p>This is the complete list of members for <a href="testqdoc-test.html">TestQDoc::Test</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#Test" translate="no">Test</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b></span>(bool, const char *) : void (*)(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b></span>(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b></span>(int, int) : int</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b></span>(int, bool) const</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b></span>(TestQDoc::Test &&) : TestQDoc::Test &</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test-obsolete.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test-obsolete.html new file mode 100644 index 000000000..81cc19f7d --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test-obsolete.html @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace."> + <title>Obsolete Members for Test | Test 6.2.11</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>Test</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Obsolete Members for Test</h1> +<p><b>The following members of class <a href="testqdoc-test.html" translate="no">Test</a> are deprecated.</b> They are provided to keep old source code working. We strongly advise against using them in new code.</p> +<h2>Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#anotherObsoleteMember" translate="no">anotherObsoleteMember</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated in 6.0)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#deprecatedMember" translate="no">deprecatedMember</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#obsoleteMember" translate="no">obsoleteMember</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> TestQDoc::Test &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#operator-2b-2b" translate="no">operator++</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> TestQDoc::Test &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#operator--" translate="no">operator--</a></b>()</td></tr> +</table></div> +<h2>Member Function Documentation</h2> +<!-- $$$ --> +<div class="fngroup"> +<h3 class="fn fngroupitem" translate="no" id="operator-2b-2b"><code class="details extra" translate="no">[deprecated]</code> <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &Test::<span class="name">operator++</span>()</h3><h3 class="fn fngroupitem" translate="no" id="operator--"><code class="details extra" translate="no">[deprecated]</code> <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &Test::<span class="name">operator--</span>()</h3></div> +<p>This function is deprecated. We strongly advise against using it in new code.</p> +<!-- @@@ --> +<!-- $$$anotherObsoleteMember[overload1]$$$anotherObsoleteMember --> +<h3 class="fn" translate="no" id="anotherObsoleteMember"><code class="details extra" translate="no">[deprecated]</code> <span class="type">void</span> Test::<span class="name">anotherObsoleteMember</span>()</h3> +<p>This function is deprecated. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test-obsolete.html#obsoleteMember" translate="no">obsoleteMember</a>() instead.</p> +<!-- @@@anotherObsoleteMember --> +<!-- $$$deprecatedMember[overload1]$$$deprecatedMember --> +<h3 class="fn" translate="no" id="deprecatedMember"><code class="details extra" translate="no">[deprecated in 6.0]</code> <span class="type">void</span> Test::<span class="name">deprecatedMember</span>()</h3> +<p>This function is deprecated since 6.0. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test.html#someFunction" translate="no">someFunction</a>() instead.</p> +<!-- @@@deprecatedMember --> +<!-- $$$obsoleteMember[overload1]$$$obsoleteMember --> +<h3 class="fn" translate="no" id="obsoleteMember"><code class="details extra" translate="no">[deprecated]</code> <span class="type">void</span> Test::<span class="name">obsoleteMember</span>()</h3> +<p>This function is deprecated. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test.html#someFunction" translate="no">someFunction</a>() instead.</p> +<!-- @@@obsoleteMember --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test.html new file mode 100644 index 000000000..25e1966aa --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test.html @@ -0,0 +1,165 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace."> + <title>Test Class | Test 6.2.11</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>Test</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#public-types">Public Types</a></li> +<li class="level1"><a href="#public-functions">Public Functions</a></li> +<li class="level1"><a href="#protected-functions">Protected Functions</a></li> +<li class="level1"><a href="#related-non-members">Related Non-Members</a></li> +<li class="level1"><a href="#macros">Macros</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Test Class</h1> +<span class="small-subtitle" translate="no">class <a href="testqdoc.html" translate="no">TestQDoc</a>::Test</span> +<!-- $$$Test-brief --> +<p>A class in a namespace. <a href="#details">More...</a></p> +<!-- @@@Test --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Test></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> In QML:</td><td class="memItemRight bottomAlign"> <a href="qml-qdoc-test-type.html" translate="no">Type</a></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></p> +</td></tr> +</table></div> +<ul> +<li><a href="testqdoc-test-members.html">List of all members, including inherited members</a></li> +<li><a href="testqdoc-test-obsolete.html">Deprecated members</a></li> +<li>Test is part of <a href="cpptypes.html">Test C++ Types</a>.</li> +</ul> +<p><b>Note:</b> All functions in this class are <a href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</a> with the following exceptions:</p> +<ul> +<li><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a>(int i, bool b) const</li> +</ul> +<h2 id="public-types">Public Types</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></td></tr> +</table></div> +<h2 id="public-functions">Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#Test" translate="no">Test</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void (*)(bool) </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b>(bool <i>b</i>, const char *<i>s</i>)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since Test 1.0)</code> int </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b>(int, int <i>v</i> = 0)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since 2.0)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b>(int <i>i</i>, bool <i>b</i> = false) const</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> TestQDoc::Test &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b>(TestQDoc::Test &&<i>other</i>)</td></tr> +</table></div> +<h2 id="protected-functions">Protected Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since Test 1.2)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b>(bool <i>b</i>)</td></tr> +</table></div> +<h2 id="related-non-members">Related Non-Members</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq-eq" translate="no">operator==</a></b>(const TestQDoc::Test &<i>lhs</i>, const TestQDoc::Test &<i>rhs</i>)</td></tr> +</table></div> +<h2 id="macros">Macros</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since Test 1.1)</code> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a></b>(int &<i>x</i>)</td></tr> +</table></div> +<!-- $$$Test-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@Test --> +<div class="types"> +<h2>Member Type Documentation</h2> +<!-- $$$SomeType --> +<h3 class="fn" translate="no" id="SomeType-typedef">Test::<span class="name">SomeType</span></h3> +<p>A typedef.</p> +<!-- @@@SomeType --> +</div> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$ --> +<div class="fngroup"> +<h3 class="fn fngroupitem" translate="no" id="overload"><code class="details extra" translate="no">[protected]</code> <span class="type">void</span> Test::<span class="name">overload</span>()</h3><h3 class="fn fngroupitem" translate="no" id="overload-1"><code class="details extra" translate="no">[protected, since Test 1.2]</code> <span class="type">void</span> Test::<span class="name">overload</span>(<span class="type">bool</span> <i>b</i>)</h3></div> +<p>Overloads that share a documentation comment, optionally taking a parameter <i translate="no">b</i>.</p> +<!-- @@@ --> +<!-- $$$Test[overload1]$$$Test --> +<h3 class="fn" translate="no" id="Test">Test::<span class="name">Test</span>()</h3> +<p>The constructor is deleted.</p> +<!-- @@@Test --> +<!-- $$$funcPtr[overload1]$$$funcPtrboolconstchar* --> +<h3 class="fn" translate="no" id="funcPtr"><span class="type">void</span> (*)(<span class="type">bool</span>) Test::<span class="name">funcPtr</span>(<span class="type">bool</span> <i>b</i>, const <span class="type">char</span> *<i>s</i>)</h3> +<p>Returns a pointer to a function that takes a boolean. Uses <i translate="no">b</i> and <i translate="no">s</i>.</p> +<!-- @@@funcPtr --> +<!-- $$$inlineFunction[overload1]$$$inlineFunction --> +<h3 class="fn" translate="no" id="inlineFunction"><span class="type">void</span> Test::<span class="name">inlineFunction</span>()</h3> +<p>An inline function, documented using the \fn QDoc command.</p> +<!-- @@@inlineFunction --> +<!-- $$$methodWithEmDashInItsDocs[overload1]$$$methodWithEmDashInItsDocs --> +<h3 class="fn" translate="no" id="methodWithEmDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEmDashInItsDocs</span>()</h3> +<p>This method has em dashes in its documentation—as you'll find represented by <code translate="no">---</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.</p> +<p>-----------------------------------------------------------------------</p> +<p>People can still add a bunch of dashes, though, without QDoc replacing them all with a series of em dashes.</p> +<p>—You can also start a new paragraph with an em dash, if you want to.</p> +<p><b>See also </b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a>.</p> +<!-- @@@methodWithEmDashInItsDocs --> +<!-- $$$methodWithEnDashInItsDocs[overload1]$$$methodWithEnDashInItsDocs --> +<h3 class="fn" translate="no" id="methodWithEnDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEnDashInItsDocs</span>()</h3> +<p>This method has en dashes in its documentation – as you'll find represented by <code translate="no">--</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:</p> +<pre class="cpp" translate="no"><span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">42</span>; i <span class="operator">></span> <span class="number">0</span>; <span class="operator">-</span><span class="operator">-</span>i) + <span class="comment">// Do something cool during countdown.</span></pre> +<p>...as it would be silly if this would output –i instead of <code translate="no">--i</code>.</p> +<p>-----------------------------------------------------------------------</p> +<p>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:</p> +<hr /> +<p>– You can also start a new paragraph with an en dash, if you want to.</p> +<p><b>See also </b>methodWithEnDashInItsDocs.</p> +<!-- @@@methodWithEnDashInItsDocs --> +<!-- $$$someFunction[overload1]$$$someFunctionintint --> +<h3 class="fn" translate="no" id="someFunction"><code class="details extra" translate="no">[since Test 1.0]</code> <span class="type">int</span> Test::<span class="name">someFunction</span>(<span class="type">int</span>, <span class="type">int</span> <i>v</i> = 0)</h3> +<p>Function that takes a parameter <i translate="no">v</i>. Also returns the value of <i translate="no">v</i>.</p> +<p>This function was introduced in Test 1.0.</p> +<!-- @@@someFunction --> +<!-- $$$someFunctionDefaultArg[overload1]$$$someFunctionDefaultArgintbool --> +<h3 class="fn" translate="no" id="someFunctionDefaultArg"><code class="details extra" translate="no">[since 2.0]</code> <span class="type">void</span> Test::<span class="name">someFunctionDefaultArg</span>(<span class="type">int</span> <i>i</i>, <span class="type">bool</span> <i>b</i> = false) const</h3> +<p>Function that takes a parameter <i translate="no">i</i> and <i translate="no">b</i>.</p> +<p><b>Warning:</b> This function is not <a href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</a>.</p> +<p>This function was introduced in Qt 2.0.</p> +<!-- @@@someFunctionDefaultArg --> +<!-- $$$virtualFun[overload1]$$$virtualFun --> +<h3 class="fn" translate="no" id="virtualFun"><code class="details extra" translate="no">[virtual]</code> <span class="type">void</span> Test::<span class="name">virtualFun</span>()</h3> +<p>Function that must be reimplemented.</p> +<!-- @@@virtualFun --> +<!-- $$$operator=[overload1]$$$operator=TestQDoc::Test&& --> +<h3 class="fn" translate="no" id="operator-eq"><span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &Test::<span class="name">operator=</span>(<span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &&<i>other</i>)</h3> +<p>The move assignment operator is deleted. <i translate="no">other</i> cannot be moved from.</p> +<!-- @@@operator= --> +</div> +<div class="relnonmem"> +<h2>Related Non-Members</h2> +<!-- $$$operator==[overload1]$$$operator==constTestQDoc::Test&constTestQDoc::Test& --> +<h3 class="fn" translate="no" id="operator-eq-eq"><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> +<p>Returns true if <i translate="no">lhs</i> and <i translate="no">rhs</i> are equal.</p> +<!-- @@@operator== --> +</div> +<div class="macros"> +<h2>Macro Documentation</h2> +<!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> +<h3 class="fn" translate="no" id="QDOCTEST_MACRO2"><code class="details extra" translate="no">[since Test 1.1]</code> <span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> +<p>A macro with argument <i translate="no">x</i>.</p> +<p>This macro was introduced in Test 1.1.</p> +<!-- @@@QDOCTEST_MACRO2 --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived-members.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived-members.html new file mode 100644 index 000000000..f263a0b7b --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived-members.html @@ -0,0 +1,50 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace, derived from Test."> + <title>List of All Members for TestDerived | Test 6.2.11</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>TestDerived</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for TestDerived</h1> +<p>This is the complete list of members for <a href="testqdoc-testderived.html">TestQDoc::TestDerived</a>, including inherited members.</p> +<div class="table"><table class="propsummary" translate="no"> +<tr><td class="topAlign"><ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#DerivedType-typedef" translate="no">DerivedType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#NotTypedef-typedef" translate="no">NotTypedef</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#bindableProp-prop" translate="no">bindableProp</a></b></span>() : QBindable<QString></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#bindableProp-prop" translate="no">bindablePropChanged</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">boolProp</a></b></span>() : bool</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">boolPropChanged</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#emitSomething" translate="no">emitSomething</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b></span>(bool, const char *) : void (*)(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#intProp-prop" translate="no">getInt</a></b></span>() : int *</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#id" translate="no">id</a></b></span>() : int</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#invokeMe" translate="no">invokeMe</a></b></span>() const</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b></span>()</li> +</ul></td><td class="topAlign"><ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#name-prop" translate="no">name</a></b></span>() const : const QString *</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b></span>(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">resetBoolProp</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#bindableProp-prop" translate="no">setBindableProp</a></b></span>(const QString &)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">setBoolProp</a></b></span>(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b></span>(int, int) : int</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b></span>(int, bool) const</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#someProp-prop" translate="no">someProp</a></b></span>() : const QString &</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#someValue" translate="no">someValue</a></b></span>() : TestQDoc::TestDerived::NotTypedef</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b></span>(TestQDoc::Test &&) : TestQDoc::Test &</li> +</ul> +</td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived-obsolete.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived-obsolete.html new file mode 100644 index 000000000..e293b8595 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived-obsolete.html @@ -0,0 +1,26 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace, derived from Test."> + <title>Obsolete Members for TestDerived | Test 6.2.11</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>TestDerived</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Obsolete Members for TestDerived</h1> +<p><b>The following members of class <a href="testqdoc-testderived.html" translate="no">TestDerived</a> are deprecated.</b> They are provided to keep old source code working. We strongly advise against using them in new code.</p> +<h2>Static Public Members</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived-obsolete.html#staticObsoleteMember" translate="no">staticObsoleteMember</a></b>()</td></tr> +</table></div> +<h2>Member Function Documentation</h2> +<!-- $$$staticObsoleteMember[overload1]$$$staticObsoleteMember --> +<h3 class="fn" translate="no" id="staticObsoleteMember"><code class="details extra" translate="no">[static, deprecated]</code> <span class="type">void</span> TestDerived::<span class="name">staticObsoleteMember</span>()</h3> +<p>This function is deprecated. We strongly advise against using it in new code.</p> +<p>Static obsolete method.</p> +<!-- @@@staticObsoleteMember --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived.html new file mode 100644 index 000000000..8c1c895e3 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-testderived.html @@ -0,0 +1,173 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace, derived from Test."> + <title>TestDerived Class | Test 6.2.11</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>TestDerived</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#public-types">Public Types</a></li> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#public-functions">Public Functions</a></li> +<li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li> +<li class="level1"><a href="#public-slots">Public Slots</a></li> +<li class="level1"><a href="#signals">Signals</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TestDerived Class</h1> +<span class="small-subtitle" translate="no">class <a href="testqdoc.html" translate="no">TestQDoc</a>::TestDerived</span> +<!-- $$$TestDerived-brief --> +<p>A class in a namespace, derived from <a href="testqdoc-test.html" translate="no">Test</a>. <a href="#details">More...</a></p> +<!-- @@@TestDerived --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <TestDerived></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 2.0</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> In QML:</td><td class="memItemRight bottomAlign"> <a href="qml-themodule-thetype.html" translate="no">TheType</a></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></td></tr> +</table></div> +<ul> +<li><a href="testqdoc-testderived-members.html">List of all members, including inherited members</a></li> +<li><a href="testqdoc-testderived-obsolete.html">Deprecated members</a></li> +</ul> +<h2 id="public-types">Public Types</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#DerivedType-typedef" translate="no">DerivedType</a></b></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#NotTypedef-typedef" translate="no">NotTypedef</a></b></td></tr> +</table></div> +<h2 id="properties">Properties</h2> +<div class="table"><table class="propsummary" translate="no"> +<tr><td class="topAlign"><ul> +<li class="fn" translate="no"><b><a href="testqdoc-testderived.html#bindableProp-prop" translate="no">bindableProp</a></b> : QString</li> +<li class="fn" translate="no"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">boolProp</a></b> : bool</li> +<li class="fn" translate="no"><b><a href="testqdoc-testderived.html#intProp-prop" translate="no">intProp</a></b> : int* const</li> +</ul></td><td class="topAlign"><ul> +<li class="fn" translate="no"><b><a href="testqdoc-testderived.html#name-prop" translate="no">name</a></b> : const QString*</li> +<li class="fn" translate="no"><b><a href="testqdoc-testderived.html#someProp-prop" translate="no">someProp</a></b> : QString</li> +</ul> +</td></tr> +</table></div> +<h2 id="public-functions">Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> QBindable<QString> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#bindableProp-prop" translate="no">bindableProp</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">boolProp</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> int *</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#intProp-prop" translate="no">getInt</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#invokeMe" translate="no">invokeMe</a></b>() const</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> const QString *</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#name-prop" translate="no">name</a></b>() const</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> const QString &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#someProp-prop" translate="no">someProp</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> TestQDoc::TestDerived::NotTypedef </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#someValue" translate="no">someValue</a></b>()</td></tr> +</table></div> +<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#id" translate="no">id</a></b>() override</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#virtualFun" translate="no">virtualFun</a></b>() override</td></tr> +</table></div> +<h2 id="public-slots">Public Slots</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">resetBoolProp</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#bindableProp-prop" translate="no">setBindableProp</a></b>(const QString &<i>s</i>)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">setBoolProp</a></b>(bool <i>b</i>)</td></tr> +</table></div> +<h2 id="signals">Signals</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#bindableProp-prop" translate="no">bindablePropChanged</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#boolProp-prop" translate="no">boolPropChanged</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#emitSomething" translate="no">emitSomething</a></b>()</td></tr> +</table></div> +<!-- $$$TestDerived-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@TestDerived --> +<div class="types"> +<h2>Member Type Documentation</h2> +<!-- $$$DerivedType --> +<h3 class="fn" translate="no" id="DerivedType-typedef"><code class="details extra" translate="no">[alias]</code> TestDerived::<span class="name">DerivedType</span></h3> +<p>An aliased typedef.</p> +<!-- @@@DerivedType --> +<!-- $$$NotTypedef --> +<h3 class="fn" translate="no" id="NotTypedef-typedef"><code class="details extra" translate="no">[alias]</code> TestDerived::<span class="name">NotTypedef</span></h3> +<p>I'm an alias, not a typedef.</p> +<!-- @@@NotTypedef --> +</div> +<div class="prop"> +<h2>Property Documentation</h2> +<!-- $$$bindableProp-prop$$$bindableProp$$$setBindablePropconstQString&$$$bindablePropChanged --> +<h3 class="fn" translate="no" id="bindableProp-prop"><code class="details extra" translate="no">[bindable]</code> <span class="name">bindableProp</span> : <span class="type">QString</span></h3> +<div class="admonition note"><p><b>Note: </b>This property supports <a href="https://wiki.qt.io/QProperty">QProperty</a> bindings.</p> +</div><p>Some property.</p> +<p><b>See also </b><a href="testqdoc-testderived.html#someProp-prop" translate="no">someProp</a>.</p> +<!-- @@@bindableProp --> +<!-- $$$boolProp-prop$$$boolProp$$$setBoolPropbool$$$resetBoolProp$$$boolPropChanged --> +<h3 class="fn" translate="no" id="boolProp-prop"><span class="name">boolProp</span> : <span class="type">bool</span></h3> +<p>A boolean property.</p> +<p><b>Access functions:</b></p> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>boolProp</b></span>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBoolProp</b></span>(bool <i>b</i>)</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>resetBoolProp</b></span>()</td></tr> +</table></div> +<p><b>Notifier signal:</b></p> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>boolPropChanged</b></span>()</td></tr> +</table></div> +<!-- @@@boolProp --> +<!-- $$$intProp-prop$$$getInt --> +<h3 class="fn" translate="no" id="intProp-prop"><code class="details extra" translate="no">[read-only]</code> <span class="name">intProp</span> : <span class="type">int</span>* const</h3> +<p>An integer property.</p> +<p><b>Access functions:</b></p> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft topAlign rightAlign"> int *</td><td class="memItemRight bottomAlign"><span class="name"><b>getInt</b></span>()</td></tr> +</table></div> +<!-- @@@intProp --> +<!-- $$$name-prop$$$name --> +<h3 class="fn" translate="no" id="name-prop"><code class="details extra" translate="no">[read-only]</code> <span class="name">name</span> : const <span class="type">QString</span>*</h3> +<p>This property holds a name.</p> +<p><b>Access functions:</b></p> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft topAlign rightAlign"> const QString *</td><td class="memItemRight bottomAlign"><span class="name"><b>name</b></span>() const</td></tr> +</table></div> +<!-- @@@name --> +<!-- $$$someProp-prop$$$someProp --> +<h3 class="fn" translate="no" id="someProp-prop"><code class="details extra" translate="no">[bindable read-only]</code> <span class="name">someProp</span> : <span class="type">QString</span></h3> +<div class="admonition note"><p><b>Note: </b>This property supports <a href="https://wiki.qt.io/QProperty">QProperty</a> bindings.</p> +</div><p>Another property.</p> +<!-- @@@someProp --> +</div> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$emitSomething[overload1]$$$emitSomething --> +<h3 class="fn" translate="no" id="emitSomething"><code class="details extra" translate="no">[private signal]</code> <span class="type">void</span> TestDerived::<span class="name">emitSomething</span>()</h3> +<p>Emitted when things happen.</p> +<div class="admonition note"><p><b>Note: </b>This is a private signal. It can be used in signal connections but cannot be emitted by the user.</p> +</div><!-- @@@emitSomething --> +<!-- $$$id[overload1]$$$id --> +<h3 class="fn" translate="no" id="id"><code class="details extra" translate="no">[override virtual]</code> <span class="type">int</span> TestDerived::<span class="name">id</span>()</h3> +<!-- @@@id --> +<!-- $$$invokeMe[overload1]$$$invokeMe --> +<h3 class="fn" translate="no" id="invokeMe"><code class="details extra" translate="no">[invokable]</code> <span class="type">void</span> TestDerived::<span class="name">invokeMe</span>() const</h3> +<p>Something invokable.</p> +<div class="admonition note"><p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p> +</div><!-- @@@invokeMe --> +<!-- $$$someValue[overload1]$$$someValue --> +<h3 class="fn" translate="no" id="someValue"><span class="type"><a href="testqdoc-testderived.html#NotTypedef-typedef" translate="no">TestQDoc::TestDerived::NotTypedef</a></span> TestDerived::<span class="name">someValue</span>()</h3> +<p>Returns a value using an aliases type.</p> +<!-- @@@someValue --> +<!-- $$$virtualFun[overload1]$$$virtualFun --> +<h3 class="fn" translate="no" id="virtualFun"><code class="details extra" translate="no">[override virtual]</code> <span class="type">void</span> TestDerived::<span class="name">virtualFun</span>()</h3> +<p>Reimplements: <a href="testqdoc-test.html#virtualFun" translate="no">Test::virtualFun</a>().</p> +<!-- @@@virtualFun --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc.html new file mode 100644 index 000000000..7ccc7f4dd --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc.html @@ -0,0 +1,65 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A namespace."> + <title>TestQDoc Namespace | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#classes">Classes</a></li> +<li class="level1"><a href="#macros">Macros</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#usage">Usage</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TestQDoc Namespace</h1> +<!-- $$$TestQDoc-brief --> +<p>A namespace. <a href="#details">More...</a></p> +<!-- @@@TestQDoc --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <TestCPP></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 2.0</td></tr> +</table></div> +<h2 id="classes">Classes</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since 1.1)</code> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html" translate="no">Test</a></b></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since 2.0)</code> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html" translate="no">TestDerived</a></b></td></tr> +</table></div> +<h2 id="macros">Macros</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since Test 0.9)</code> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc.html#QDOCTEST_MACRO" translate="no">QDOCTEST_MACRO</a></b></td></tr> +</table></div> +<!-- $$$TestQDoc-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<h3 id="usage">Usage</h3> +<p>This namespace is for testing QDoc output.</p> +</div> +<!-- @@@TestQDoc --> +<div class="classes"> +<h2>Classes</h2> +<h3> class <a href="testqdoc-test.html">Test</a></h3><!-- $$$Test-brief --> +<p>A class in a namespace. <a href="testqdoc-test.html#details">More...</a></p> +<!-- @@@Test --> +<h3> class <a href="testqdoc-testderived.html">TestDerived</a></h3><!-- $$$TestDerived-brief --> +<p>A class in a namespace, derived from <a href="testqdoc-test.html" translate="no">Test</a>. <a href="testqdoc-testderived.html#details">More...</a></p> +<!-- @@@TestDerived --> +</div> +<div class="macros"> +<h2>Macro Documentation</h2> +<!-- $$$QDOCTEST_MACRO[overload1]$$$QDOCTEST_MACRO --> +<h3 class="fn" translate="no" id="QDOCTEST_MACRO"><code class="details extra" translate="no">[since Test 0.9]</code> <span class="name">QDOCTEST_MACRO</span></h3> +<p>This macro was introduced in Test 0.9.</p> +<!-- @@@QDOCTEST_MACRO --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testtagfile.tags b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testtagfile.tags new file mode 100644 index 000000000..f68dffed6 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testtagfile.tags @@ -0,0 +1,500 @@ +<?xml version="1.0" encoding="UTF-8"?> +<tagfile> + <compound kind="class"> + <name>QDoc.Test.AbstractParent</name> + <filename>qml-qdoc-test-abstractparent.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>name</name> + <anchorfile>qml-qdoc-test-abstractparent.html</anchorfile> + <anchor>name-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>name</name> + <anchorfile>qml-qdoc-test-abstractparent.html</anchorfile> + <anchor>name-method</anchor> + <arglist>(Child child, name)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>rear</name> + <anchorfile>qml-qdoc-test-abstractparent.html</anchorfile> + <anchor>rear-method</anchor> + <arglist>(Child child, var method)</arglist> + </member> + </compound> + <compound kind="class"> + <name>QDoc.Test.Child</name> + <filename>qml-qdoc-test-child.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>name</name> + <anchorfile>qml-qdoc-test-child.html</anchorfile> + <anchor>name-method</anchor> + <arglist>(Child child, name)</arglist> + </member> + </compound> + <compound kind="namespace"> + <name>CrossModuleRef</name> + <filename>crossmoduleref.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>documentMe</name> + <anchorfile>crossmoduleref.html</anchorfile> + <anchor>documentMe</anchor> + <arglist>()</arglist> + </member> + </compound> + <compound kind="class"> + <name>QDoc.Test.DocTest</name> + <filename>qml-qdoc-test-doctest.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>completed</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>completed-signal</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>fail</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>fail-method</anchor> + <arglist>(message)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>fail_hard</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>fail_hard-method</anchor> + <arglist>(msg, option)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>foo</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>foo-signal</anchor> + <arglist>(var bar)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>itsHappening</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>itsHappening-signal</anchor> + <arglist>(bool really)</arglist> + </member> + </compound> + <compound kind="class"> + <name>Test.NoVer.DocTest</name> + <filename>qml-test-nover-doctest.html</filename> + </compound> + <compound kind="class"> + <name>QDoc.Test.OldType</name> + <filename>qml-qdoc-test-oldtype.html</filename> + </compound> + <compound kind="class"> + <name>UIComponents.ProgressBar</name> + <filename>qml-uicomponents-progressbar.html</filename> + </compound> + <compound kind="class"> + <name>SeenClass</name> + <filename>seenclass.html</filename> + </compound> + <compound kind="class"> + <name>UIComponents.Switch</name> + <filename>qml-uicomponents-switch.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>toggle</name> + <anchorfile>qml-uicomponents-switch.html</anchorfile> + <anchor>toggle-method</anchor> + <arglist>()</arglist> + </member> + </compound> + <compound kind="class"> + <name>UIComponents.TabWidget</name> + <filename>qml-uicomponents-tabwidget.html</filename> + </compound> + <compound kind="namespace"> + <name>TestQDoc</name> + <filename>testqdoc.html</filename> + <class>TestQDoc::Test</class> + <class>TestQDoc::TestDerived</class> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>QDOCTEST_MACRO</name> + <anchorfile>testqdoc.html</anchorfile> + <anchor>QDOCTEST_MACRO</anchor> + <arglist>QDOCTEST_MACRO</arglist> + </member> + </compound> + <compound kind="class"> + <name>TestQDoc::Test</name> + <filename>testqdoc-test.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>QDOCTEST_MACRO2</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>QDOCTEST_MACRO2</anchor> + <arglist>(int &x)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>Test</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>Test</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>TestQDoc::Test &</type> + <name>operator++</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>operator-2b-2b</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>TestQDoc::Test &</type> + <name>operator--</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>operator--</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>TestQDoc::Test &</type> + <name>operator=</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>operator-eq</anchor> + <arglist>(TestQDoc::Test &&other)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>bool</type> + <name>operator==</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>operator-eq-eq</anchor> + <arglist>(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>int</type> + <name>someFunction</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>someFunction</anchor> + <arglist>(int, int v)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void (*)(bool)</type> + <name>funcPtr</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>funcPtr</anchor> + <arglist>(*)(bool) funcPtr(bool b, const char *s)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>anotherObsoleteMember</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>anotherObsoleteMember</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>deprecatedMember</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>deprecatedMember</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>inlineFunction</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>inlineFunction</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>methodWithEmDashInItsDocs</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>methodWithEmDashInItsDocs</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>methodWithEnDashInItsDocs</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>methodWithEnDashInItsDocs</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>obsoleteMember</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>obsoleteMember</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="protected" virtualness="non" static="no"> + <type>void</type> + <name>overload</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>overload</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="protected" virtualness="non" static="no"> + <type>void</type> + <name>overload</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>overload-1</anchor> + <arglist>(bool b)</arglist> + </member> + <member kind="function" protection="public" virtualness="virtual" static="no"> + <type>virtual void</type> + <name>virtualFun</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>virtualFun</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>someFunctionDefaultArg</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>someFunctionDefaultArg</anchor> + <arglist>(int i, bool b) const const</arglist> + </member> + <member kind="typedef" type=""> + <name>SomeType</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>SomeType-typedef</anchor> + <arglist></arglist> + </member> + </compound> + <compound kind="class"> + <name>TestQDoc::TestDerived</name> + <filename>testqdoc-testderived.html</filename> + <base>Test</base> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>QBindable<QString></type> + <name>bindableProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>bindableProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>TestQDoc::TestDerived::NotTypedef</type> + <name>someValue</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>someValue</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>bool</type> + <name>boolProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>const QString &</type> + <name>someProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>someProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>int *</type> + <name>getInt</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>intProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="virtual" static="no"> + <type>virtual int</type> + <name>id</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>id</anchor> + <arglist>() override</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>bindablePropChanged</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>bindableProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>boolPropChanged</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>emitSomething</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>emitSomething</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>resetBoolProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>setBindableProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>bindableProp-prop</anchor> + <arglist>(const QString &s)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>setBoolProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist>(bool b)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="yes"> + <type>void</type> + <name>staticObsoleteMember</name> + <anchorfile>testqdoc-testderived-obsolete.html</anchorfile> + <anchor>staticObsoleteMember</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="virtual" static="no"> + <type>virtual void</type> + <name>virtualFun</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>virtualFun</anchor> + <arglist>() override</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>const QString *</type> + <name>name</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>name-prop</anchor> + <arglist>() const const</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>invokeMe</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>invokeMe</anchor> + <arglist>() const const</arglist> + </member> + <member kind="typedef" type=""> + <name>DerivedType</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>DerivedType-typedef</anchor> + <arglist></arglist> + </member> + <member kind="typedef" type=""> + <name>NotTypedef</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>NotTypedef-typedef</anchor> + <arglist></arglist> + </member> + <member kind="property" type="QString"> + <name>bindableProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>bindableProp-prop</anchor> + <arglist></arglist> + </member> + <member kind="property" type="bool"> + <name>boolProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist></arglist> + </member> + <member kind="property" type="int*"> + <name>intProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>intProp-prop</anchor> + <arglist></arglist> + </member> + <member kind="property" type="const QString*"> + <name>name</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>name-prop</anchor> + <arglist></arglist> + </member> + <member kind="property" type="QString"> + <name>someProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>someProp-prop</anchor> + <arglist></arglist> + </member> + </compound> + <compound kind="class"> + <name>TheModule.TheType</name> + <filename>qml-themodule-thetype.html</filename> + </compound> + <compound kind="class"> + <name>QDoc.Test.Type</name> + <filename>qml-qdoc-test-type.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>Type</type> + <name>copy</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>copy-method</anchor> + <arglist>(a)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>completed</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>completed-signal</anchor> + <arglist>(int status)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>configured</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>configured-signal</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>deprecatedMethod</name> + <anchorfile>qml-qdoc-test-type-obsolete.html</anchorfile> + <anchor>deprecatedMethod-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>disable</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>disable-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>enable</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>enable-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>futureDeprecated</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>futureDeprecated-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>group.created</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>group.created-signal</anchor> + <arglist>()</arglist> + </member> + </compound> + <compound kind="class"> + <name>Test.NoVer.TypeNoVersion</name> + <filename>qml-test-nover-typenoversion.html</filename> + </compound> + <compound kind="class"> + <name>QDoc.Test.YetAnotherChild</name> + <filename>qml-qdoc-test-yetanotherchild.html</filename> + </compound> +</tagfile> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/themodule-qmlmodule.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/themodule-qmlmodule.html new file mode 100644 index 000000000..e3d28561d --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/themodule-qmlmodule.html @@ -0,0 +1,18 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- properties.qdoc --> + <title>Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<!-- $$$TheModule-description --> +<div class="descr" id="details"> +</div> +<!-- @@@TheModule --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-themodule-thetype.html">TheType</a></p></td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/uicomponents-qmlmodule.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/uicomponents-qmlmodule.html new file mode 100644 index 000000000..e45470a92 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/uicomponents-qmlmodule.html @@ -0,0 +1,24 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- examples.qdoc --> + <meta name="description" content="Basic set of UI components."> + <title>UI Components | Test 6.2.11</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">UI Components</h1> +<!-- $$$UIComponents-description --> +<div class="descr" id="details"> +<p>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.</p> +<p>This module is part of the <a href="test-componentset-example.html">UIComponents</a> example.</p> +</div> +<!-- @@@UIComponents --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-uicomponents-progressbar.html">ProgressBar</a></p></td><td class="tblDescr"><p>A component that shows the progress of an event</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qml-uicomponents-switch.html">Switch</a></p></td><td class="tblDescr"><p>A component that can be turned on or off</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-uicomponents-tabwidget.html">TabWidget</a></p></td><td class="tblDescr"><p>A widget that places its children as tabs</p></td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/autolinking.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/autolinking.webxml new file mode 100644 index 000000000..91f35d5d7 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/autolinking.webxml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="autolinking.html" href="autolinking.html" status="active" location="classlists.qdoc" documented="true" subtype="page" title="Autolinking" fulltitle="Autolinking" subtitle=""> + <contents name="testqdoc" title="TestQDoc" level="1"/> + <contents name="someprop" title="someProp" level="1"/> + <description> + <section id="testqdoc"> + <heading level="1">TestQDoc</heading> + <para>The string <link raw="TestQDoc" href="testqdoc.html" type="namespace">TestQDoc</link> links to the C++ namespace unless linking explicitly, <link raw="#TestQDoc" href="autolinking.html#testqdoc" type="page" page="Autolinking">like this</link>, or <link raw="TestQDoc" href="testqdoc.html" type="namespace">this</link>. Also,</para> + <para>Autolinks:</para> + <list type="bullet"> + <item> + <para> + <link raw="TestQDoc::TestDerived" href="testqdoc-testderived.html" type="class">TestQDoc::TestDerived</link></para> + </item> + </list> + <para>Explicit links:</para> + <list type="bullet"> + <item> + <para> + <link raw="TestQDoc::TestDerived" href="testqdoc-testderived.html" type="class">TestQDoc::TestDerived</link></para> + </item> + <item> + <para> + <link raw="Obsolete Classes#TestQDoc" href="obsolete-classes.html#testqdoc" type="page" page="Obsolete Classes">Obsolete Classes#TestQDoc</link></para> + </item> + </list> + </section> + <section id="someprop"> + <heading level="1">someProp</heading> + </section> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/classes.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/classes.webxml new file mode 100644 index 000000000..55faed6d6 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/classes.webxml @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="classes.html" href="classes.html" status="active" location="unseenclass.qdoc" documented="true" subtype="page" title="Classes" fulltitle="Classes" subtitle=""> + <description> + <generatedlist contents="annotatedclasses"/> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/cpptypes.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/cpptypes.webxml new file mode 100644 index 000000000..df7cd7024 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/cpptypes.webxml @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <group name="cpptypes" href="cpptypes.html" status="active" location="classlists.qdoc" documented="true" seen="true" title="Test C++ Types"> + <description> + <generatedlist contents="testgroup"/> + <table width="100%"> + <row> + <item> + <para> + <link raw="TestQDoc::Test" href="testqdoc-test.html" type="class"/> + </para> + </item> + <item> + <para>A class in a namespace.</para> + </item> + </row> + </table> + </description> + </group> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/crossmoduleref.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/crossmoduleref.webxml new file mode 100644 index 000000000..682799bd8 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/crossmoduleref.webxml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <namespace name="CrossModuleRef" href="crossmoduleref.html" status="active" access="public" location="testcpp.h" since="3.0" documented="true" module="TestCPP" brief="Namespace that has documented functions in multiple modules"> + <description> + <brief>Namespace that has documented functions in multiple modules.</brief> + </description> + <function name="documentMe" fullname="CrossModuleRef::documentMe" href="crossmoduleref.html#documentMe" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void documentMe()"> + <description> + <para>Document me!</para> + </description> + </function> + </namespace> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/images/leonardo-da-vinci.png b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/images/leonardo-da-vinci.png Binary files differnew file mode 100644 index 000000000..854acb4ca --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/images/leonardo-da-vinci.png diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/obsolete-classes.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/obsolete-classes.webxml new file mode 100644 index 000000000..dda841458 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/obsolete-classes.webxml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="obsolete-classes.html" href="obsolete-classes.html" status="active" location="classlists.qdoc" documented="true" subtype="page" title="Obsolete Classes" fulltitle="Obsolete Classes" subtitle=""> + <contents name="classes-with-obsolete-members" title="Classes with obsolete members" level="1"/> + <contents name="testqdoc" title="TestQDoc" level="2"/> + <description> + <section id="classes-with-obsolete-members"> + <heading level="1">Classes with obsolete members</heading> + <generatedlist contents="obsoletecppmembers"/> + </section> + <section id="testqdoc"> + <heading level="2">TestQDoc</heading> + </section> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/qdoc-test-qmlmodule.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/qdoc-test-qmlmodule.webxml new file mode 100644 index 000000000..5d24b3077 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/qdoc-test-qmlmodule.webxml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document/> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/qmlmodules.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/qmlmodules.webxml new file mode 100644 index 000000000..dffd151d2 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/qmlmodules.webxml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="qmlmodules.html" href="qmlmodules.html" status="active" location="modules.qdoc" documented="true" subtype="page" title="QML Modules" fulltitle="QML Modules" subtitle=""> + <contents name="qml-types" title="QML types" level="1"/> + <contents name="qml-value-types" title="QML value types" level="1"/> + <description> + <generatedlist contents="qml-modules"/> + <section id="qml-types"> + <heading level="1">QML types</heading> + <generatedlist contents="qmltypesbymodule QDoc.Test"/> + </section> + <section id="qml-value-types"> + <heading level="1">QML value types</heading> + <generatedlist contents="qmlvaluetypes"/> + <generatedlist contents="qmlvaluetypesbymodule QDoc.Test"/> + </section> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/seenclass.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/seenclass.webxml new file mode 100644 index 000000000..92c2ad8f0 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/seenclass.webxml @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <class name="SeenClass" href="seenclass.html" status="active" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"> + <description> + <brief>A public but undocumented class.</brief> + </description> + </class> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-cmakelists-txt.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-cmakelists-txt.webxml new file mode 100644 index 000000000..7b4bf2ce6 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-cmakelists-txt.webxml @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="cmaketest/CMakeLists.txt" href="test-cmaketest-cmakelists-txt.html" title="CMakeLists.txt Example File" fulltitle="CMakeLists.txt Example File" subtitle="cmaketest/CMakeLists.txt"> + <description> + <code>cmake_minimum_required(VERSION 3.16) +project (QDOCTEST)</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-example.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-example.webxml new file mode 100644 index 000000000..b0cd15b27 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-example.webxml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="cmaketest" href="test-cmaketest-example.html" status="active" location="cmaketest.qdoc" documented="true" subtype="example" title="CMake Example Project" fulltitle="CMake Example Project" subtitle=""> + <description> + <image href="images/leonardo-da-vinci.png"/> + <para>Files:</para> + <list type="bullet"> + <item> + <para> + <link raw="cmaketest/CMakeLists.txt" href="test-cmaketest-cmakelists-txt.html" type="page" page="CMakeLists.txt Example File">cmaketest/CMakeLists.txt</link> + </para> + </item> + <item> + <para> + <link raw="cmaketest/main.cpp" href="test-cmaketest-main-cpp.html" type="page" page="main.cpp Example File">cmaketest/main.cpp</link> + </para> + </item> + </list> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-main-cpp.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-main-cpp.webxml new file mode 100644 index 000000000..7d22ced82 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-cmaketest-main-cpp.webxml @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="cmaketest/main.cpp" href="test-cmaketest-main-cpp.html" title="main.cpp Example File" fulltitle="main.cpp Example File" subtitle="cmaketest/main.cpp"> + <description> + <code><@type>void</@type> main(){}</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-componentset-pro.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-componentset-pro.webxml new file mode 100644 index 000000000..08be3fa28 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-componentset-pro.webxml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="componentset/componentset.pro" href="test-componentset-componentset-pro.html" title="componentset.pro Example File" fulltitle="componentset.pro Example File" subtitle="componentset/componentset.pro"> + <description> + <code>SOURCES = componentset.pro \ + ProgressBar.qml \ + Switch.qml \ + TabWidget.qml \ + uicomponents.qdoc</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-componentset-qml.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-componentset-qml.webxml new file mode 100644 index 000000000..0a4297da0 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-componentset-qml.webxml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="componentset/componentset.qml" href="test-componentset-componentset-qml.html" title="componentset.qml Example File" fulltitle="componentset.qml Example File" subtitle="componentset/componentset.qml"> + <description> + <code><@comment>// Copyright (C) 2023 The Qt Company Ltd.</@comment> +<@comment>// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0</@comment> + +import QtQuick 2.0 + +<@type>Item</@type> { +}</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-example.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-example.webxml new file mode 100644 index 000000000..600f2f3ed --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-example.webxml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="componentset" href="test-componentset-example.html" status="active" location="examples.qdoc" documented="true" subtype="example" title="QML Documentation Example" fulltitle="QML Documentation Example" subtitle="" brief="Example for documenting QML types"> + <contents name="qml-class" title="QML Class" level="1"/> + <contents name="properties-signals-handlers-and-methods" title="Properties, Signals, Handlers, and Methods" level="1"/> + <contents name="internal-documentation" title="Internal Documentation" level="2"/> + <contents name="qml-types-with-c-implementation" title="QML Types with C++ Implementation" level="1"/> + <description> + <brief>Example for documenting QML types.</brief> + <para>This example demonstrates one of the ways to document QML types. It also generates a warning about a missing example image, on purpose.</para> + <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 <link raw="UI Components" href="uicomponents-qmlmodule.html" type="">UI Components</link> module.</para> + <para>The uicomponents.qdoc file generates the overview page for the <link raw="UI Components" href="uicomponents-qmlmodule.html" type="">UI Components</link> module page.</para> + <para>The generated documentation is available in the <link raw="UI Components" href="uicomponents-qmlmodule.html" type="">UI Components</link> module.</para> + <section id="qml-class"> + <heading level="1">QML Class</heading> + <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 <teletype type="highlighted">UIComponents</teletype> module.</para> + <para>QDoc uses the \brief command to place a basic description when listing the types.</para> + </section> + <section id="properties-signals-handlers-and-methods"> + <heading level="1">Properties, Signals, Handlers, and Methods</heading> + <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.</para> + <para>To document the type of a <italic>property alias</italic>, you must use the \qmlproperty command to specify the data type.</para> + <code>\qmlproperty int anAliasedProperty +An aliased property of type int.</code> + </section> + <section id="internal-documentation"> + <heading level="2">Internal Documentation</heading> + <para>You may declare that a documentation is for internal use by placing the \internal command after the beginning QDoc comment <teletype type="highlighted">/*</teletype>. QDoc will prevent the internal documentation from appearing in the public API.</para> + <para>If you wish to omit certain parts of the documentation, you may use the \omit and \endomit command.</para> + </section> + <section id="qml-types-with-c-implementation"> + <heading level="1">QML Types with C++ Implementation</heading> + <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.</para> + </section> + <para>Files:</para> + <list type="bullet"> + <item> + <para> + <link raw="componentset/ProgressBar.qml" href="test-componentset-progressbar-qml.html" type="page" page="ProgressBar.qml Example File">componentset/ProgressBar.qml</link> + </para> + </item> + <item> + <para> + <link raw="componentset/Switch.qml" href="test-componentset-switch-qml.html" type="page" page="Switch.qml Example File">componentset/Switch.qml</link> + </para> + </item> + <item> + <para> + <link raw="componentset/TabWidget.qml" href="test-componentset-tabwidget-qml.html" type="page" page="TabWidget.qml Example File">componentset/TabWidget.qml</link> + </para> + </item> + <item> + <para> + <link raw="componentset/componentset.pro" href="test-componentset-componentset-pro.html" type="page" page="componentset.pro Example File">componentset/componentset.pro</link> + </para> + </item> + <item> + <para> + <link raw="componentset/componentset.qml" href="test-componentset-componentset-qml.html" type="page" page="componentset.qml Example File">componentset/componentset.qml</link> + </para> + </item> + </list> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-progressbar-qml.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-progressbar-qml.webxml new file mode 100644 index 000000000..6b5d2f8ac --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-progressbar-qml.webxml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="componentset/ProgressBar.qml" href="test-componentset-progressbar-qml.html" title="ProgressBar.qml Example File" fulltitle="ProgressBar.qml Example File" subtitle="componentset/ProgressBar.qml"> + <description> + <code><@comment>// Copyright (C) 2016 The Qt Company Ltd.</@comment> +<@comment>// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause</@comment> + +import QtQuick 1.0 + +<@comment>/*! + \qmltype ProgressBar + \inqmlmodule UIComponents + \brief A component that shows the progress of an event. + + A ProgressBar shows the linear progress of an event as its \l value. + The range is specified using the \l {minimum} and the \l{maximum} values. + + The ProgressBar component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. +*/</@comment> +<@type>Item</@type> { + <@name>id</@name>: <@name>progressbar</@name> + + <@comment>/*! + The minimum value of the ProgressBar range. + The \l value must not be less than this value. + */</@comment> + property <@type>int</@type> <@name>minimum</@name>: <@number>0</@number> + + <@comment>/*! + The maximum value of the ProgressBar range. + The \l value must not be more than this value. + */</@comment> + property <@type>int</@type> <@name>maximum</@name>: <@number>100</@number> + + <@comment>/*! + The value of the progress. + */</@comment> + property <@type>int</@type> <@name>value</@name>: <@number>0</@number> + + <@comment>/*! + \qmlproperty color ProgressBar::color + The color of the ProgressBar's gradient. Must bind to a color type. + + \omit + The &quot;\qmlproperty &lt;type&gt; &lt;property name&gt;&quot; is needed because + property alias need to have their types manually entered. + + QDoc will not publish the documentation within omit and endomit. + \endomit + + \sa secondColor + */</@comment> + property <@type>alias</@type> <@name>color</@name>: <@name>gradient1</@name>.<@name>color</@name> + + <@comment>/*! + \qmlproperty color ProgressBar::secondColor + The second color of the ProgressBar's gradient. + Must bind to a color type. + + \omit + The &quot;\qmlproperty &lt;type&gt; &lt;property name&gt;&quot; is needed because + property alias need to have their types manually entered. + + QDoc will not publish the documentation within omit and endomit. + \endomit + + \sa color + */</@comment> + property <@type>alias</@type> <@name>secondColor</@name>: <@name>gradient2</@name>.<@name>color</@name> + + <@name>width</@name>: <@number>250</@number>; <@name>height</@name>: <@number>23</@number> + <@name>clip</@name>: <@number>true</@number> + + <@type>Rectangle</@type> { + <@name>id</@name>: <@name>highlight</@name> + + <@comment>/*! + An internal documentation comment. The widthDest property is not + a public API and therefore will not be exposed. + */</@comment> + property <@type>int</@type> <@name>widthDest</@name>: ((<@name>progressbar</@name>.<@name>width</@name> <@op>*</@op> (<@name>value</@name> <@op>-</@op> <@name>minimum</@name>)) <@op>/</@op> (<@name>maximum</@name> <@op>-</@op> <@name>minimum</@name>) <@op>-</@op> <@number>6</@number>) + + <@name>width</@name>: <@name>highlight</@name>.<@name>widthDest</@name> + Behavior on <@name>width</@name> { <@type>SmoothedAnimation</@type> { <@name>velocity</@name>: <@number>1200</@number> } } + + <@type>anchors</@type> { <@name>left</@name>: <@name>parent</@name>.<@name>left</@name>; <@name>top</@name>: <@name>parent</@name>.<@name>top</@name>; <@name>bottom</@name>: <@name>parent</@name>.<@name>bottom</@name>; <@name>margins</@name>: <@number>3</@number> } + <@name>radius</@name>: <@number>1</@number> + <@name>gradient</@name>: <@name>Gradient</@name> { + <@type>GradientStop</@type> { <@name>id</@name>: <@name>gradient1</@name>; <@name>position</@name>: <@number>0.0</@number> } + <@type>GradientStop</@type> { <@name>id</@name>: <@name>gradient2</@name>; <@name>position</@name>: <@number>1.0</@number> } + } + + } + <@type>Text</@type> { + <@type>anchors</@type> { <@name>right</@name>: <@name>highlight</@name>.<@name>right</@name>; <@name>rightMargin</@name>: <@number>6</@number>; <@name>verticalCenter</@name>: <@name>parent</@name>.<@name>verticalCenter</@name> } + <@name>color</@name>: <@string>&quot;white&quot;</@string> + <@name>font</@name>.bold: <@number>true</@number> + <@name>text</@name>: <@name>Math</@name>.<@name>floor</@name>((<@name>value</@name> <@op>-</@op> <@name>minimum</@name>) <@op>/</@op> (<@name>maximum</@name> <@op>-</@op> <@name>minimum</@name>) <@op>*</@op> <@number>100</@number>) <@op>+</@op> <@string>'%'</@string> + } +}</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-switch-qml.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-switch-qml.webxml new file mode 100644 index 000000000..4e09d9f25 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-switch-qml.webxml @@ -0,0 +1,112 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="componentset/Switch.qml" href="test-componentset-switch-qml.html" title="Switch.qml Example File" fulltitle="Switch.qml Example File" subtitle="componentset/Switch.qml"> + <description> + <code><@comment>// Copyright (C) 2016 The Qt Company Ltd.</@comment> +<@comment>// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause</@comment> + +import QtQuick 1.0 + +<@comment>/*! + \qmltype ToggleSwitch + \inqmlmodule UIComponents + \brief A component that can be turned on or off. + + A toggle switch has two states: an \c on and an \c off state. The \c off + state is when the \l on property is set to \c false. + + The ToggleSwitch component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. + +*/</@comment> +<@type>Item</@type> { + <@name>id</@name>: <@name>toggleswitch</@name> + <@name>width</@name>: <@name>background</@name>.<@name>width</@name>; <@name>height</@name>: <@name>background</@name>.<@name>height</@name> + + <@comment>/*! + Indicates the state of the switch. If \c false, then the switch is in + the \c off state. + + \omit + The \qmlproperty &lt;type&gt; &lt;propertyname&gt; is not necessary as QDoc + will associate this property to the ToggleSwitch + + QDoc will not publish the documentation within omit and endomit. + \endomit + */</@comment> + property <@type>bool</@type> <@name>on</@name>: <@number>false</@number> + + <@comment>/*! + A method to toggle the switch. If the switch is \c on, the toggling it + will turn it \c off. Toggling a switch in the \c off position will + turn it \c on. + */</@comment> + <@keyword>function </@keyword><@name>toggle</@name>() { + <@keyword>if</@keyword> (<@name>toggleswitch</@name>.<@name>state</@name> <@op>==</@op> <@string>&quot;on&quot;</@string>) + <@name>toggleswitch</@name>.<@name>state</@name> <@op>=</@op> <@string>&quot;off&quot;</@string>; + <@keyword>else</@keyword> + <@name>toggleswitch</@name>.<@name>state</@name> <@op>=</@op> <@string>&quot;on&quot;</@string>; + } + + <@comment>/*! + \internal + + An internal function to synchronize the switch's internals. This + function is not for public access. The \internal command will + prevent QDoc from publishing this comment in the public API. + */</@comment> + <@keyword>function </@keyword><@name>releaseSwitch</@name>() { + <@keyword>if</@keyword> (<@name>knob</@name>.<@name>x</@name> <@op>==</@op> <@number>1</@number>) { + <@keyword>if</@keyword> (<@name>toggleswitch</@name>.<@name>state</@name> <@op>==</@op> <@string>&quot;off&quot;</@string>) <@keyword>return</@keyword>; + } + <@keyword>if</@keyword> (<@name>knob</@name>.<@name>x</@name> <@op>==</@op> <@number>78</@number>) { + <@keyword>if</@keyword> (<@name>toggleswitch</@name>.<@name>state</@name> <@op>==</@op> <@string>&quot;on&quot;</@string>) <@keyword>return</@keyword>; + } + <@name>toggle</@name>(); + } + + <@type>Rectangle</@type> { + <@name>id</@name>: <@name>background</@name> + <@name>width</@name>: <@number>130</@number>; <@name>height</@name>: <@number>48</@number> + <@name>radius</@name>: <@number>48</@number> + <@name>color</@name>: <@string>&quot;lightsteelblue&quot;</@string> + <@type>MouseArea</@type> { <@name>anchors</@name>.fill: <@name>parent</@name>; <@name>onClicked</@name>: <@name>toggle</@name>() } + } + + <@type>Rectangle</@type> { + <@name>id</@name>: <@name>knob</@name> + <@name>width</@name>: <@number>48</@number>; <@name>height</@name>: <@number>48</@number> + <@name>radius</@name>: <@name>width</@name> + <@name>color</@name>: <@string>&quot;lightblue&quot;</@string> + + <@type>MouseArea</@type> { + <@name>anchors</@name>.fill: <@name>parent</@name> + <@name>drag</@name>.target: <@name>knob</@name>; <@name>drag</@name>.axis: <@name>Drag</@name>.<@name>XAxis</@name>; <@name>drag</@name>.minimumX: <@number>1</@number>; <@name>drag</@name>.maximumX: <@number>78</@number> + <@name>onClicked</@name>: <@name>toggle</@name>() + <@name>onReleased</@name>: <@name>releaseSwitch</@name>() + } + } + + <@name>states</@name>: [ + <@type>State</@type> { + <@name>name</@name>: <@string>&quot;on&quot;</@string> + <@type>PropertyChanges</@type> { <@name>target</@name>: <@name>knob</@name>; <@name>x</@name>: <@number>78</@number> } + <@type>PropertyChanges</@type> { <@name>target</@name>: <@name>toggleswitch</@name>; <@name>on</@name>: <@number>true</@number> } + }, + <@type>State</@type> { + <@name>name</@name>: <@string>&quot;off&quot;</@string> + <@type>PropertyChanges</@type> { <@name>target</@name>: <@name>knob</@name>; <@name>x</@name>: <@number>1</@number> } + <@type>PropertyChanges</@type> { <@name>target</@name>: <@name>toggleswitch</@name>; <@name>on</@name>: <@number>false</@number> } + } + ] + + <@name>transitions</@name>: <@name>Transition</@name> { + <@type>NumberAnimation</@type> { <@name>properties</@name>: <@string>&quot;x&quot;</@string>; <@name>easing</@name>.type: <@name>Easing</@name>.<@name>InOutQuad</@name>; <@name>duration</@name>: <@number>200</@number> } + } +}</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-tabwidget-qml.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-tabwidget-qml.webxml new file mode 100644 index 000000000..6ee3ce5dc --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-componentset-tabwidget-qml.webxml @@ -0,0 +1,154 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="componentset/TabWidget.qml" href="test-componentset-tabwidget-qml.html" title="TabWidget.qml Example File" fulltitle="TabWidget.qml Example File" subtitle="componentset/TabWidget.qml"> + <description> + <code><@comment>// Copyright (C) 2016 The Qt Company Ltd.</@comment> +<@comment>// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause</@comment> + +import QtQuick 1.0 + +<@comment>/*! + \qmltype TabWidget + \inqmlmodule UIComponents + \brief A widget that places its children as tabs. + + A TabWidget places its children as tabs in a view. Selecting + a tab involves selecting the tab at the top. + + The TabWidget component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. + + \section1 Adding Tabs + + To add a tab, declare the tab as a child of the TabWidget. + + \code + TabWidget { + id: tabwidget + + Rectangle { + id: tab1 + color: &quot;red&quot; + //... omitted + } + Rectangle { + id: tab2 + color: &quot;blue&quot; + //... omitted + } + + } + \endcode + +*/</@comment> +<@type>Item</@type> { + <@name>id</@name>: <@name>tabWidget</@name> + + <@comment>/*! + \internal + + Setting the default property to stack.children means any child items + of the TabWidget are actually added to the 'stack' item's children. + + See the \l{&quot;Property Binding in QML&quot;} + documentation for details on default properties. + + This is an implementation detail, not meant for public knowledge. Putting + the \internal command at the beginning will cause QDoc to not publish this + documentation in the public API page. + + Normally, a property alias needs to have a + &quot;\qmlproperty &lt;type&gt; &lt;propertyname&gt;&quot; to assign the alias a type. + + */</@comment> + default property <@type>alias</@type> <@name>content</@name>: <@name>stack</@name>.<@name>children</@name> + + <@comment>/*! + The currently active tab in the TabWidget. + */</@comment> + property <@type>int</@type> <@name>current</@name>: <@number>0</@number> + + <@comment>/*! + A sample \c{read-only} property. + A contrived property to demonstrate QDoc's ability to detect + read-only properties. + + The signature is: + \code + readonly property int sampleReadOnlyProperty: 0 + \endcode + + Note that the property must be initialized to a value. + + */</@comment> + readonly property <@type>int</@type> <@name>sampleReadOnlyProperty</@name>: <@number>0</@number> + + <@comment>/*! + \internal + + This handler is an implementation + detail. The \c{\internal} command will prevent QDoc from publishing this + documentation on the public API. + */</@comment> + <@name>onCurrentChanged</@name>: <@name>setOpacities</@name>() + <@name>Component</@name>.onCompleted: <@name>setOpacities</@name>() + + <@comment>/*! + \internal + + An internal function to set the opacity. + The \internal command will prevent QDoc from publishing this + documentation on the public API. + */</@comment> + <@keyword>function </@keyword><@name>setOpacities</@name>() { + <@keyword>for</@keyword> (var i = 0; <@name>i</@name> <@op>&lt;</@op> <@name>stack</@name>.<@name>children</@name>.<@name>length</@name>; ++<@name>i</@name>) { + <@name>stack</@name>.<@name>children</@name>[<@name>i</@name>].<@name>opacity</@name> <@op>=</@op> (<@name>i</@name> <@op>==</@op> <@name>current</@name> ? <@number>1</@number> : <@number>0</@number>) + } + } + + <@type>Row</@type> { + <@name>id</@name>: <@name>header</@name> + + <@type>Repeater</@type> { + <@name>model</@name>: <@name>stack</@name>.<@name>children</@name>.<@name>length</@name> + <@name>delegate</@name>: <@name>Rectangle</@name> { + <@name>width</@name>: <@name>tabWidget</@name>.<@name>width</@name> <@op>/</@op> <@name>stack</@name>.<@name>children</@name>.<@name>length</@name>; <@name>height</@name>: <@number>36</@number> + + <@type>Rectangle</@type> { + <@name>width</@name>: <@name>parent</@name>.<@name>width</@name>; <@name>height</@name>: <@number>1</@number> + <@type>anchors</@type> { <@name>bottom</@name>: <@name>parent</@name>.<@name>bottom</@name>; <@name>bottomMargin</@name>: <@number>1</@number> } + <@name>color</@name>: <@string>&quot;#acb2c2&quot;</@string> + } + <@type>BorderImage</@type> { + <@type>anchors</@type> { <@name>fill</@name>: <@name>parent</@name>; <@name>leftMargin</@name>: <@number>2</@number>; <@name>topMargin</@name>: <@number>5</@number>; <@name>rightMargin</@name>: <@number>1</@number> } + <@type>border</@type> { <@name>left</@name>: <@number>7</@number>; <@name>right</@name>: <@number>7</@number> } + <@name>source</@name>: <@string>&quot;tab.png&quot;</@string> + <@name>visible</@name>: <@name>tabWidget</@name>.<@name>current</@name> <@op>==</@op> <@name>index</@name> + } + <@type>Text</@type> { + <@name>horizontalAlignment</@name>: <@name>Qt</@name>.<@name>AlignHCenter</@name>; <@name>verticalAlignment</@name>: <@name>Qt</@name>.<@name>AlignVCenter</@name> + <@name>anchors</@name>.fill: <@name>parent</@name> + <@name>text</@name>: <@name>stack</@name>.<@name>children</@name>[<@name>index</@name>].<@name>title</@name> + <@name>elide</@name>: <@name>Text</@name>.<@name>ElideRight</@name> + <@name>font</@name>.bold: <@name>tabWidget</@name>.<@name>current</@name> <@op>==</@op> <@name>index</@name> + } + <@type>MouseArea</@type> { + <@name>anchors</@name>.fill: <@name>parent</@name> + <@name>onClicked</@name>: <@name>tabWidget</@name>.<@name>current</@name> <@op>=</@op> <@name>index</@name> + } + } + } + } + + <@type>Item</@type> { + <@name>id</@name>: <@name>stack</@name> + <@name>width</@name>: <@name>tabWidget</@name>.<@name>width</@name> + <@name>anchors</@name>.top: <@name>header</@name>.<@name>bottom</@name>; <@name>anchors</@name>.bottom: <@name>tabWidget</@name>.<@name>bottom</@name> + } +}</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-demo-cpp.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-demo-cpp.webxml new file mode 100644 index 000000000..fd0268d30 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-demo-cpp.webxml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="demos/demo/demo.cpp" href="test-demos-demo-demo-cpp.html" title="demo.cpp Example File" fulltitle="demo.cpp Example File" subtitle="demos/demo/demo.cpp"> + <description> + <code><@comment>// Copyright (C) 2023 The Qt Company Ltd.</@comment> +<@comment>// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0</@comment> + +<@type>bool</@type> isOverThousand(<@type>int</@type> n) +{ + <@keyword>if</@keyword> (n <@op>&gt;</@op> <@number>1'000</@number>) + <@keyword>return</@keyword> <@keyword>true</@keyword>; + <@keyword>return</@keyword> <@keyword>false</@keyword>; +}</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-demo-pro.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-demo-pro.webxml new file mode 100644 index 000000000..45f8457e9 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-demo-pro.webxml @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="demos/demo/demo.pro" href="test-demos-demo-demo-pro.html" title="demo.pro Example File" fulltitle="demo.pro Example File" subtitle="demos/demo/demo.pro"> + <description> + <code>TEMPLATE = aux +message(&quot;Nothing to see here.&quot;)</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-dontxclude-cmakelists-txt.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-dontxclude-cmakelists-txt.webxml new file mode 100644 index 000000000..effb3cfb9 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-dontxclude-cmakelists-txt.webxml @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="demos/demo/dontxclude/CMakeLists.txt" href="test-demos-demo-dontxclude-cmakelists-txt.html" title="CMakeLists.txt Example File" fulltitle="CMakeLists.txt Example File" subtitle="demos/demo/dontxclude/CMakeLists.txt"> + <description> + <code>cmake_minimum_required(VERSION 3.16) +project (DONTXCLUDEDIRS_QDOCTEST)</code> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-example.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-example.webxml new file mode 100644 index 000000000..71472790d --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-demo-example.webxml @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="demos/demo" href="test-demos-demo-example.html" status="active" location="demo.qdoc" documented="true" subtype="example" title="Demo" fulltitle="Demo" subtitle=""> + <description> + <image href="images/leonardo-da-vinci.png"/> + <code> if (n > 1'000) + return true;</code> + <para>Files:</para> + <list type="bullet"> + <item> + <para> + <link raw="demos/demo/demo.cpp" href="test-demos-demo-demo-cpp.html" type="page" page="demo.cpp Example File">demos/demo/demo.cpp</link> + </para> + </item> + <item> + <para> + <link raw="demos/demo/demo.pro" href="test-demos-demo-demo-pro.html" type="page" page="demo.pro Example File">demos/demo/demo.pro</link> + </para> + </item> + <item> + <para> + <link raw="demos/demo/dontxclude/CMakeLists.txt" href="test-demos-demo-dontxclude-cmakelists-txt.html" type="page" page="CMakeLists.txt Example File">demos/demo/dontxclude/CMakeLists.txt</link> + </para> + </item> + </list> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-hidden-example.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-hidden-example.webxml new file mode 100644 index 000000000..4f87887ed --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-demos-hidden-example.webxml @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="demos/hidden" href="test-demos-hidden-example.html" status="active" location="hidden.qdoc" documented="true" subtype="example" title="Hidden Demo" fulltitle="Hidden Demo" subtitle="" brief="Tagged 'broken', does not appear in examples-manifest.xml"> + <description> + <brief>Tagged 'broken', does not appear in examples-manifest.xml.</brief> + <para>Also missing an image, but that's OK as it's broken anyway.</para> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-empty-qmlmodule.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-empty-qmlmodule.webxml new file mode 100644 index 000000000..5d24b3077 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-empty-qmlmodule.webxml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document/> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-nover-qmlmodule.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-nover-qmlmodule.webxml new file mode 100644 index 000000000..5d24b3077 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test-nover-qmlmodule.webxml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document/> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test.index b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test.index new file mode 100644 index 000000000..8f26aa523 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test.index @@ -0,0 +1,226 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE QDOCINDEX> +<INDEX url="" title="A test project for QDoc build artifacts" version="6.2.11" project="Test"> + <namespace name="" status="active" access="public" module="test"> + <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="0" since="Test 0.9" meta="macrowithoutparams" signature="QDOCTEST_MACRO"/> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" brief="A macro with argument x" signature="QDOCTEST_MACRO2(int &x)" groups="testgroup"> + <parameter type="int &" name="x" default=""/> + </function> + <qmlclass name="AbstractParent" qml-module-name="QDoc.Test" fullname="QDoc.Test.AbstractParent" href="qml-qdoc-test-abstractparent.html" status="active" access="public" abstract="true" location="parent.qdoc" since="1.1" documented="true" title="AbstractParent" fulltitle="AbstractParent" subtitle="" brief="Abstract base QML type"> + <function name="name" fullname="QDoc.Test.AbstractParent.name" href="qml-qdoc-test-abstractparent.html#name-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="void"/> + <function name="name" fullname="QDoc.Test.AbstractParent.name" href="qml-qdoc-test-abstractparent.html#name-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="void"> + <parameter type="Child" name="child" default=""/> + <parameter type="" name="name" default=""/> + </function> + <function name="rear" fullname="QDoc.Test.AbstractParent.rear" href="qml-qdoc-test-abstractparent.html#rear-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="void"> + <parameter type="Child" name="child" default=""/> + <parameter type="var" name="method" default="Strict"/> + </function> + <qmlproperty name="children" fullname="QDoc.Test.AbstractParent.children" status="active" access="public" location="parent.qdoc" documented="true" type="list<Child>" attached="false" writable="true" brief="Children of the type"/> + <qmlproperty name="name" fullname="QDoc.Test.AbstractParent.name" status="active" access="public" location="parent.qdoc" documented="true" type="string" attached="false" writable="true" brief="Name of this parent"/> + </qmlclass> + <page name="autolinking.html" href="autolinking.html" status="active" location="classlists.qdoc" documented="true" subtype="page" title="Autolinking" fulltitle="Autolinking" subtitle=""> + <contents name="testqdoc" title="TestQDoc" level="1"/> + <contents name="someprop" title="someProp" level="1"/> + </page> + <page name="cmaketest" href="test-cmaketest-example.html" status="active" location="cmaketest.qdoc" documented="true" subtype="example" title="CMake Example Project" fulltitle="CMake Example Project" subtitle=""/> + <qmlclass name="Child" qml-module-name="QDoc.Test" qml-base-type="QDoc.Test::AbstractParent" fullname="QDoc.Test.Child" href="qml-qdoc-test-child.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="Child" fulltitle="Child" subtitle="" brief="A Child inheriting its parent"> + <function name="name" fullname="QDoc.Test.Child.name" href="qml-qdoc-test-child.html#name-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="void"> + <parameter type="Child" name="child" default=""/> + <parameter type="" name="name" default=""/> + </function> + <qmlproperty name="name" fullname="QDoc.Test.Child.name" href="qml-qdoc-test-child.html#name-prop" status="active" access="public" location="parent.qdoc" documented="true" type="string" attached="false" writable="true" brief="Name of this child"/> + </qmlclass> + <page name="classes.html" href="classes.html" status="active" location="unseenclass.qdoc" documented="true" subtype="page" title="Classes" fulltitle="Classes" subtitle=""/> + <namespace name="CrossModuleRef" href="crossmoduleref.html" status="active" access="public" location="testcpp.h" since="3.0" documented="true" module="TestCPP" brief="Namespace that has documented functions in multiple modules"> + <function name="documentMe" fullname="CrossModuleRef::documentMe" href="crossmoduleref.html#documentMe" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void documentMe()"/> + </namespace> + <page name="demos/demo" href="test-demos-demo-example.html" status="active" location="demo.qdoc" documented="true" subtype="example" title="Demo" fulltitle="Demo" subtitle=""/> + <qmlclass name="DocTest" qml-module-name="QDoc.Test" fullname="QDoc.Test.DocTest" href="qml-qdoc-test-doctest.html" status="active" access="public" location="DocTest.qml" since="QDoc.Test 0.9" documented="true" title="DocTest" fulltitle="DocTest" subtitle="" brief="Represents a doc test case"> + <contents name="introduction" title="Introduction" level="1"/> + <function name="completed" fullname="QDoc.Test.DocTest.completed" href="qml-qdoc-test-doctest.html#completed-signal" status="active" access="public" documented="true" meta="qmlsignal"/> + <function name="fail" fullname="QDoc.Test.DocTest.fail" href="qml-qdoc-test-doctest.html#fail-method" status="active" access="public" location="DocTest.qml" documented="true" since="QDoc.Test 1.0" meta="qmlmethod"> + <parameter type="" name="message" default=""oops""/> + </function> + <function name="fail_hard" fullname="QDoc.Test.DocTest.fail_hard" href="qml-qdoc-test-doctest.html#fail_hard-method" status="active" access="public" documented="true" meta="qmlmethod"> + <parameter type="" name="msg" default=""facepalm""/> + <parameter type="" name="option" default="123"/> + </function> + <function name="foo" fullname="QDoc.Test.DocTest.foo" href="qml-qdoc-test-doctest.html#foo-signal" status="active" access="public" location="DocTest.qml" documented="true" meta="qmlsignal"> + <parameter type="var" name="bar" default=""/> + </function> + <function name="itsHappening" fullname="QDoc.Test.DocTest.itsHappening" href="qml-qdoc-test-doctest.html#itsHappening-signal" status="active" access="public" documented="true" meta="qmlsignal"> + <parameter type="bool" name="really" default=""/> + </function> + <qmlproperty name="active" fullname="QDoc.Test.DocTest.active" href="qml-qdoc-test-doctest.html#active-prop" status="active" access="public" documented="true" type="bool" attached="false" writable="true"/> + <qmlproperty name="name" fullname="QDoc.Test.DocTest.name" href="qml-qdoc-test-doctest.html#name-prop" status="active" access="public" documented="true" type="string" attached="false" writable="true" required="true"/> + </qmlclass> + <qmlclass name="DocTest" qml-module-name="Test.NoVer" fullname="Test.NoVer.DocTest" href="qml-test-nover-doctest.html" status="active" access="public" location="DocTest.qml" since="1.1" documented="true" title="DocTest" fulltitle="DocTest" subtitle="" brief="Shadows the type name in QDoc.Test module"/> + <class name="DontLinkToMe" href="dontlinktome.html" status="ignored" access="public" location="testcpp.h" since="2.0" documented="true" module="TestCPP" brief="Class that does not generate documentation"/> + <page name="demos/hidden" href="test-demos-hidden-example.html" status="active" location="hidden.qdoc" documented="true" subtype="example" title="Hidden Demo" fulltitle="Hidden Demo" subtitle="" brief="Tagged 'broken', does not appear in examples-manifest.xml"/> + <page name="obsolete-classes.html" href="obsolete-classes.html" status="active" location="classlists.qdoc" documented="true" subtype="page" title="Obsolete Classes" fulltitle="Obsolete Classes" subtitle=""> + <contents name="classes-with-obsolete-members" title="Classes with obsolete members" level="1"/> + <contents name="testqdoc" title="TestQDoc" level="2"/> + </page> + <qmlclass name="OldType" qml-module-name="QDoc.Test" fullname="QDoc.Test.OldType" href="qml-qdoc-test-oldtype.html" status="deprecated" access="public" since="1.1" documented="true" title="OldType" fulltitle="OldType" subtitle="" brief="Deprecated old type"/> + <qmlclass name="ProgressBar" qml-module-name="UIComponents" fullname="UIComponents.ProgressBar" href="qml-uicomponents-progressbar.html" status="active" access="public" location="ProgressBar.qml" documented="true" title="ProgressBar" fulltitle="ProgressBar" subtitle="" brief="A component that shows the progress of an event"> + <qmlproperty name="color" fullname="UIComponents.ProgressBar.color" href="qml-uicomponents-progressbar.html#color-prop" status="active" access="public" documented="true" type="color" attached="false" writable="true"/> + <qmlproperty name="maximum" fullname="UIComponents.ProgressBar.maximum" href="qml-uicomponents-progressbar.html#maximum-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true"/> + <qmlproperty name="minimum" fullname="UIComponents.ProgressBar.minimum" href="qml-uicomponents-progressbar.html#minimum-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true"/> + <qmlproperty name="secondColor" fullname="UIComponents.ProgressBar.secondColor" href="qml-uicomponents-progressbar.html#secondColor-prop" status="active" access="public" documented="true" type="color" attached="false" writable="true"/> + <qmlproperty name="value" fullname="UIComponents.ProgressBar.value" href="qml-uicomponents-progressbar.html#value-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true"/> + </qmlclass> + <page name="componentset" href="test-componentset-example.html" status="active" location="examples.qdoc" documented="true" subtype="example" title="QML Documentation Example" fulltitle="QML Documentation Example" subtitle="" brief="Example for documenting QML types"> + <contents name="qml-class" title="QML Class" level="1"/> + <contents name="properties-signals-handlers-and-methods" title="Properties, Signals, Handlers, and Methods" level="1"/> + <contents name="internal-documentation" title="Internal Documentation" level="2"/> + <contents name="qml-types-with-c-implementation" title="QML Types with C++ Implementation" level="1"/> + </page> + <page name="qmlmodules.html" href="qmlmodules.html" status="active" location="modules.qdoc" documented="true" subtype="page" title="QML Modules" fulltitle="QML Modules" subtitle=""> + <contents name="qml-types" title="QML types" level="1"/> + <contents name="qml-value-types" title="QML value types" level="1"/> + </page> + <page name="https://wiki.qt.io/QProperty" href="https://wiki.qt.io/QProperty" status="active" location="properties.qdoc" documented="true" subtype="externalpage" title="QProperty" fulltitle="QProperty" subtitle=""/> + <class name="SeenClass" href="seenclass.html" status="active" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"/> + <qmlclass name="Switch" qml-module-name="UIComponents" fullname="UIComponents.Switch" href="qml-uicomponents-switch.html" status="active" access="public" location="Switch.qml" documented="true" title="Switch" fulltitle="Switch" subtitle="" brief="A component that can be turned on or off"> + <function name="toggle" fullname="UIComponents.Switch.toggle" href="qml-uicomponents-switch.html#toggle-method" status="active" access="public" documented="true" meta="qmlmethod"/> + <qmlproperty name="on" fullname="UIComponents.Switch.on" href="qml-uicomponents-switch.html#on-prop" status="active" access="public" documented="true" type="bool" attached="false" writable="true"/> + </qmlclass> + <qmlclass name="TabWidget" qml-module-name="UIComponents" fullname="UIComponents.TabWidget" href="qml-uicomponents-tabwidget.html" status="active" access="public" location="TabWidget.qml" documented="true" title="TabWidget" fulltitle="TabWidget" subtitle="" brief="A widget that places its children as tabs"> + <contents name="adding-tabs" title="Adding Tabs" level="1"/> + <qmlproperty name="current" fullname="UIComponents.TabWidget.current" href="qml-uicomponents-tabwidget.html#current-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true"/> + <qmlproperty name="sampleReadOnlyProperty" fullname="UIComponents.TabWidget.sampleReadOnlyProperty" href="qml-uicomponents-tabwidget.html#sampleReadOnlyProperty-prop" status="active" access="public" documented="true" type="int" attached="false" writable="false"/> + </qmlclass> + <namespace name="TestQDoc" href="testqdoc.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" module="TestCPP" brief="A namespace"> + <contents name="usage" title="Usage" level="1"/> + <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="0" since="Test 0.9" meta="macrowithoutparams" signature="QDOCTEST_MACRO"/> + <class threadsafety="reentrant" name="Test" fullname="TestQDoc::Test" href="testqdoc-test.html" status="active" access="public" location="testcpp.h" since="1.1" documented="true" groups="cpptypes,testgroup" module="TestCPP" brief="A class in a namespace"> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" brief="A macro with argument x" signature="QDOCTEST_MACRO2(int &x)" groups="testgroup"> + <parameter type="int &" name="x" default=""/> + </function> + <function name="Test" fullname="TestQDoc::Test::Test" href="testqdoc-test.html#Test" status="active" access="public" location="testcpp.h" documented="true" meta="constructor" signature="Test()"/> + <function name="anotherObsoleteMember" fullname="TestQDoc::Test::anotherObsoleteMember" href="testqdoc-test-obsolete.html#anotherObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void anotherObsoleteMember()"/> + <function name="deprecatedMember" fullname="TestQDoc::Test::deprecatedMember" href="testqdoc-test-obsolete.html#deprecatedMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void deprecatedMember()"/> + <function name="funcPtr" fullname="TestQDoc::Test::funcPtr" href="testqdoc-test.html#funcPtr" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void (*)(bool)" signature="void (*)(bool) funcPtr(bool b, const char *s)"> + <parameter type="bool" name="b" default=""/> + <parameter type="const char *" name="s" default=""/> + </function> + <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"/> + <function name="methodWithEmDashInItsDocs" fullname="TestQDoc::Test::methodWithEmDashInItsDocs" href="testqdoc-test.html#methodWithEmDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEmDashInItsDocs()"/> + <function name="methodWithEnDashInItsDocs" fullname="TestQDoc::Test::methodWithEnDashInItsDocs" href="testqdoc-test.html#methodWithEnDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEnDashInItsDocs()"/> + <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void obsoleteMember()"/> + <function name="operator++" fullname="TestQDoc::Test::operator++" href="testqdoc-test-obsolete.html#operator-2b-2b" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator++()"/> + <function name="operator--" fullname="TestQDoc::Test::operator--" href="testqdoc-test-obsolete.html#operator--" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator--()"/> + <function name="operator=" fullname="TestQDoc::Test::operator=" href="testqdoc-test.html#operator-eq" status="active" access="public" location="testcpp.h" documented="true" meta="move-assign" type="TestQDoc::Test &" signature="TestQDoc::Test & operator=(TestQDoc::Test &&other)" groups="testgroup"> + <parameter type="TestQDoc::Test &&" name="other" default=""/> + </function> + <function name="operator==" href="testqdoc-test.html#operator-eq-eq" status="active" access="public" location="testcpp.h" documented="true" related="2" meta="plain" type="bool" signature="bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)"> + <parameter type="const TestQDoc::Test &" name="lhs" default=""/> + <parameter type="const TestQDoc::Test &" name="rhs" default=""/> + </function> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" documented="true" meta="plain" type="void" signature="void overload()"/> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" documented="true" since="Test 1.2" meta="plain" overload="true" overload-number="1" type="void" signature="void overload(bool b)"> + <parameter type="bool" name="b" default=""/> + </function> + <function name="someFunction" fullname="TestQDoc::Test::someFunction" href="testqdoc-test.html#someFunction" status="active" access="public" location="testcpp.h" documented="true" since="Test 1.0" meta="plain" type="int" signature="int someFunction(int, int v)"> + <parameter type="int" name="" default=""/> + <parameter type="int" name="v" default="0"/> + </function> + <function name="someFunctionDefaultArg" fullname="TestQDoc::Test::someFunctionDefaultArg" href="testqdoc-test.html#someFunctionDefaultArg" threadsafety="non-reentrant" status="active" access="public" location="testcpp.h" documented="true" since="2.0" meta="plain" const="true" type="void" signature="void someFunctionDefaultArg(int i, bool b) const" groups="testgroup"> + <parameter type="int" name="i" default=""/> + <parameter type="bool" name="b" default="false"/> + </function> + <function name="virtualFun" fullname="TestQDoc::Test::virtualFun" href="testqdoc-test.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" type="void" signature="void virtualFun()"/> + <typedef name="SomeType" fullname="TestQDoc::Test::SomeType" href="testqdoc-test.html#SomeType-typedef" status="active" access="public" location="testcpp.h" documented="true"/> + </class> + <class name="TestDerived" fullname="TestQDoc::TestDerived" href="testqdoc-testderived.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" bases="TestQDoc::Test" module="TestCPP" brief="A class in a namespace, derived from Test"> + <function name="bindableProp" fullname="TestQDoc::TestDerived::bindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="bindableProp" type="QBindable<QString>" signature="QBindable<QString> bindableProp()"/> + <function name="bindablePropChanged" fullname="TestQDoc::TestDerived::bindablePropChanged" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="signal" associated-property="bindableProp" type="void" signature="void bindablePropChanged()"/> + <function name="boolProp" fullname="TestQDoc::TestDerived::boolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="boolProp" type="bool" signature="bool boolProp()"/> + <function name="boolPropChanged" fullname="TestQDoc::TestDerived::boolPropChanged" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="signal" associated-property="boolProp" type="void" signature="void boolPropChanged()"/> + <function name="emitSomething" fullname="TestQDoc::TestDerived::emitSomething" href="testqdoc-testderived.html#emitSomething" status="active" access="public" location="testcpp.h" documented="true" meta="signal" type="void" signature="void emitSomething()"/> + <function name="getInt" fullname="TestQDoc::TestDerived::getInt" href="testqdoc-testderived.html#intProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="intProp" type="int *" signature="int * getInt()"/> + <function name="id" fullname="TestQDoc::TestDerived::id" href="testqdoc-testderived.html#id" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="int" signature="int id() override"/> + <function name="invokeMe" fullname="TestQDoc::TestDerived::invokeMe" href="testqdoc-testderived.html#invokeMe" status="active" access="public" location="testcpp.h" documented="true" meta="plain" const="true" type="void" brief="Something invokable" signature="void invokeMe() const"/> + <function name="name" fullname="TestQDoc::TestDerived::name" href="testqdoc-testderived.html#name-prop" status="active" access="public" location="testcpp.h" meta="plain" const="true" associated-property="name" type="const QString *" signature="const QString * name() const"/> + <function name="resetBoolProp" fullname="TestQDoc::TestDerived::resetBoolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="boolProp" type="void" signature="void resetBoolProp()"/> + <function name="setBindableProp" fullname="TestQDoc::TestDerived::setBindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="bindableProp" type="void" signature="void setBindableProp(const QString &s)"> + <parameter type="const QString &" name="s" default=""/> + </function> + <function name="setBoolProp" fullname="TestQDoc::TestDerived::setBoolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="boolProp" type="void" signature="void setBoolProp(bool b)"> + <parameter type="bool" name="b" default=""/> + </function> + <function name="someProp" fullname="TestQDoc::TestDerived::someProp" href="testqdoc-testderived.html#someProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="someProp" type="const QString &" signature="const QString & someProp()"/> + <function name="someValue" fullname="TestQDoc::TestDerived::someValue" href="testqdoc-testderived.html#someValue" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::TestDerived::NotTypedef" signature="TestQDoc::TestDerived::NotTypedef someValue()"/> + <function name="staticObsoleteMember" fullname="TestQDoc::TestDerived::staticObsoleteMember" href="testqdoc-testderived-obsolete.html#staticObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" static="true" type="void" signature="void staticObsoleteMember()"/> + <function name="virtualFun" fullname="TestQDoc::TestDerived::virtualFun" href="testqdoc-testderived.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="void" signature="void virtualFun() override"/> + <typedef name="DerivedType" fullname="TestQDoc::TestDerived::DerivedType" href="testqdoc-testderived.html#DerivedType-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="Test::SomeType"/> + <typedef name="NotTypedef" fullname="TestQDoc::TestDerived::NotTypedef" href="testqdoc-testderived.html#NotTypedef-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="int"/> + <property name="bindableProp" fullname="TestQDoc::TestDerived::bindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" documented="true" bindable="true"> + <getter name="bindableProp"/> + <setter name="setBindableProp"/> + <notifier name="bindablePropChanged"/> + </property> + <property name="boolProp" fullname="TestQDoc::TestDerived::boolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" documented="true"> + <getter name="boolProp"/> + <setter name="setBoolProp"/> + <resetter name="resetBoolProp"/> + <notifier name="boolPropChanged"/> + </property> + <property name="intProp" fullname="TestQDoc::TestDerived::intProp" href="testqdoc-testderived.html#intProp-prop" status="active" access="public" location="testcpp.h" documented="true" writable="false"> + <getter name="getInt"/> + </property> + <property name="name" fullname="TestQDoc::TestDerived::name" href="testqdoc-testderived.html#name-prop" status="active" access="public" location="testcpp.h" documented="true" writable="false" brief="Name"> + <getter name="name"/> + </property> + <property name="someProp" fullname="TestQDoc::TestDerived::someProp" href="testqdoc-testderived.html#someProp-prop" status="active" access="public" location="testcpp.h" documented="true" bindable="true" writable="false"> + <getter name="someProp"/> + </property> + </class> + </namespace> + <qmlclass name="TheType" qml-module-name="TheModule" fullname="TheModule.TheType" href="qml-themodule-thetype.html" status="active" access="public" location="properties.qdoc" documented="true" title="TheType" fulltitle="TheType" subtitle=""> + <qmlproperty name="name" fullname="TheModule.TheType.name" href="qml-themodule-thetype.html#name-prop" status="active" access="public" location="properties.qdoc" documented="true" type="string" attached="false" writable="false" brief="Read-only status of this property is resolved from Q_PROPERTY"/> + </qmlclass> + <qmlclass name="Type" qml-module-name="QDoc.Test" fullname="QDoc.Test.Type" href="qml-qdoc-test-type.html" status="active" access="public" since="1.1" documented="true" title="Type" fulltitle="Type" subtitle="" brief="A QML type documented in a .cpp file"> + <function name="completed" fullname="QDoc.Test.Type.completed" href="qml-qdoc-test-type.html#completed-signal" status="active" access="public" documented="true" meta="qmlsignal"> + <parameter type="int" name="status" default=""/> + </function> + <function name="configured" fullname="QDoc.Test.Type.configured" href="qml-qdoc-test-type.html#configured-signal" status="active" access="public" documented="true" meta="qmlsignal"/> + <function name="copy" fullname="QDoc.Test.Type.copy" href="qml-qdoc-test-type.html#copy-method" status="active" access="public" documented="true" meta="qmlmethod" type="Type"> + <parameter type="" name="a" default=""/> + </function> + <function name="deprecatedMethod" fullname="QDoc.Test.Type.deprecatedMethod" href="qml-qdoc-test-type-obsolete.html#deprecatedMethod-method" status="deprecated" access="public" documented="true" meta="qmlmethod"/> + <function name="disable" fullname="QDoc.Test.Type.disable" href="qml-qdoc-test-type.html#disable-method" status="active" access="public" documented="true" meta="qmlmethod"/> + <function name="enable" fullname="QDoc.Test.Type.enable" href="qml-qdoc-test-type.html#enable-method" status="active" access="public" documented="true" meta="qmlmethod"/> + <function name="futureDeprecated" fullname="QDoc.Test.Type.futureDeprecated" href="qml-qdoc-test-type.html#futureDeprecated-method" status="active" access="public" documented="true" meta="qmlmethod"/> + <function name="group.created" fullname="QDoc.Test.Type.group.created" href="qml-qdoc-test-type.html#group.created-signal" status="active" access="public" documented="true" meta="qmlsignal"/> + <qmlproperty name="fifth" fullname="QDoc.Test.Type.fifth" href="qml-qdoc-test-type.html#fifth-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A group of properties sharing a documentation comment"/> + <qmlproperty name="fourth" fullname="QDoc.Test.Type.fourth" href="qml-qdoc-test-type.html#fourth-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A group of properties sharing a documentation comment"/> + <qmlproperty name="group.first" fullname="QDoc.Test.Type.group.first" href="qml-qdoc-test-type.html#group.first-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A property group"/> + <qmlproperty name="group.second" fullname="QDoc.Test.Type.group.second" href="qml-qdoc-test-type.html#group.second-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A property group"/> + <qmlproperty name="group.third" fullname="QDoc.Test.Type.group.third" href="qml-qdoc-test-type.html#group.third-prop" status="active" access="public" documented="true" type="int" attached="false" writable="true" brief="A property group"/> + <qmlproperty name="id" fullname="QDoc.Test.Type.id" href="qml-qdoc-test-type.html#id-prop" status="active" access="public" documented="true" type="int" attached="false" writable="false" brief="A read-only property"/> + <qmlproperty name="name" fullname="QDoc.Test.Type.name" href="qml-qdoc-test-type.html#name-prop" status="active" access="public" documented="true" type="string" attached="false" writable="true" required="true" brief="Name of the Test"/> + <qmlproperty name="type" fullname="QDoc.Test.Type.type" href="qml-qdoc-test-type.html#type-attached-prop" status="active" access="public" documented="true" type="enumeration" attached="true" writable="true"/> + <qmlproperty name="group" fullname="QDoc.Test.Type.group" href="qml-qdoc-test-type.html#group-prop" status="active" access="public" documented="true"/> + </qmlclass> + <qmlclass name="TypeNoVersion" qml-module-name="Test.NoVer" fullname="Test.NoVer.TypeNoVersion" href="qml-test-nover-typenoversion.html" status="active" access="public" since="1.1" documented="true" title="TypeNoVersion" fulltitle="TypeNoVersion" subtitle="" brief="Another QML type documented in a .cpp file"/> + <class name="UnseenClass" href="unseenclass.html" status="ignored" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"/> + <qmlclass name="YetAnotherChild" qml-module-name="QDoc.Test" qml-base-type="QDoc.Test::InternParent" fullname="QDoc.Test.YetAnotherChild" href="qml-qdoc-test-yetanotherchild.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="YetAnotherChild" fulltitle="YetAnotherChild" subtitle="" brief="A type inheriting from internal abstract parent"/> + <qmlvaluetype name="int" qml-module-name="QDoc.Test" fullname="QDoc.Test.int" href="qml-int.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="int" fulltitle="int" subtitle="" brief="An integer value type"> + <function name="abs" fullname="QDoc.Test.int.abs" href="qml-int.html#abs-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="int"/> + </qmlvaluetype> + <page name="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command" href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command" status="active" location="classlists.qdoc" documented="true" subtype="externalpage" title="reentrant" fulltitle="reentrant" subtitle=""/> + <group name="cpptypes" href="cpptypes.html" status="active" location="classlists.qdoc" documented="true" seen="true" title="Test C++ Types"/> + <group name="testgroup" href="testgroup.html" status="internal" seen="false" title=""/> + <module name="TestCPP" href="testcpp-module.html" status="active" since="2.0" documented="true" seen="true" title="QDoc Test C++ Classes" brief="A test module page"> + <contents name="linking-to-function-like-things" title="Linking to function-like things" level="1"/> + <contents name="section" title="section()" level="2"/> + </module> + <qmlmodule name="QDoc.Test" qml-module-name="QDoc.Test" qml-module-version="1.1" href="qdoc-test-qmlmodule.html" status="preliminary" since="1.1" documented="true" seen="true" title="QDoc.Test QML Module" brief="QML Types for the Test module"/> + <qmlmodule name="Test.Empty" qml-module-name="Test.Empty" qml-module-version="1.0" href="test-empty-qmlmodule.html" status="active" documented="true" seen="true" title="No QML Types Here" brief="A QML module with no member types"/> + <qmlmodule name="Test.NoVer" qml-module-name="Test.NoVer" href="test-nover-qmlmodule.html" status="active" since="1.1" documented="true" seen="true" title="Versionless QML Module" brief="QML Types for the Test module without version"/> + <qmlmodule name="TheModule" qml-module-name="TheModule" href="themodule-qmlmodule.html" status="active" location="properties.qdoc" documented="true" seen="true" title=""/> + <qmlmodule name="UIComponents" qml-module-name="UIComponents" qml-module-version="1.0" href="uicomponents-qmlmodule.html" status="active" location="examples.qdoc" documented="true" seen="true" title="UI Components" brief="Basic set of UI components"/> + </namespace> +</INDEX> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testcpp-module.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testcpp-module.webxml new file mode 100644 index 000000000..5d24b3077 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testcpp-module.webxml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document/> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc-test.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc-test.webxml new file mode 100644 index 000000000..9c9766dc0 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc-test.webxml @@ -0,0 +1,121 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <class threadsafety="reentrant" name="Test" fullname="TestQDoc::Test" href="testqdoc-test.html" status="active" access="public" location="testcpp.h" since="1.1" documented="true" groups="cpptypes,testgroup" module="TestCPP" brief="A class in a namespace"> + <description> + <brief>A class in a namespace.</brief> + </description> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" brief="A macro with argument x" signature="QDOCTEST_MACRO2(int &x)" groups="testgroup"> + <parameter type="int &" name="x" default=""/> + <description> + <brief>A macro with argument <argument>x</argument>.</brief> + </description> + </function> + <function name="Test" fullname="TestQDoc::Test::Test" href="testqdoc-test.html#Test" status="active" access="public" location="testcpp.h" documented="true" meta="constructor" signature="Test()"> + <description> + <para>The constructor is deleted.</para> + </description> + </function> + <function name="anotherObsoleteMember" fullname="TestQDoc::Test::anotherObsoleteMember" href="testqdoc-test-obsolete.html#anotherObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void anotherObsoleteMember()"> + <description> + <para>Use <link raw="obsoleteMember()" href="testqdoc-test.html#obsoleteMember" type="function">obsoleteMember()</link> instead.</para> + </description> + </function> + <function name="deprecatedMember" fullname="TestQDoc::Test::deprecatedMember" href="testqdoc-test-obsolete.html#deprecatedMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void deprecatedMember()"> + <description> + <para>Use <link raw="someFunction()" href="testqdoc-test.html#someFunction" type="function">someFunction()</link> instead.</para> + </description> + </function> + <function name="funcPtr" fullname="TestQDoc::Test::funcPtr" href="testqdoc-test.html#funcPtr" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void (*)(bool)" signature="void (*)(bool) funcPtr(bool b, const char *s)"> + <parameter type="bool" name="b" default=""/> + <parameter type="const char *" name="s" default=""/> + <description> + <para>Returns a pointer to a function that takes a boolean. Uses <argument>b</argument> and <argument>s</argument>.</para> + </description> + </function> + <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"> + <description> + <brief>An inline function, documented using the \fn QDoc command.</brief> + </description> + </function> + <function name="methodWithEmDashInItsDocs" fullname="TestQDoc::Test::methodWithEmDashInItsDocs" href="testqdoc-test.html#methodWithEmDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEmDashInItsDocs()"> + <description> + <para>This method has em dashes in its documentation—as you'll find represented by <teletype type="highlighted">---</teletype> 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.</para> + <para>-----------------------------------------------------------------------</para> + <para>People can still add a bunch of dashes, though, without QDoc replacing them all with a series of em dashes.</para> + <para>—You can also start a new paragraph with an em dash, if you want to.</para> + <see-also> + <link raw="methodWithEnDashInItsDocs" href="testqdoc-test.html#methodWithEnDashInItsDocs" type="function">methodWithEnDashInItsDocs</link> + </see-also> + </description> + </function> + <function name="methodWithEnDashInItsDocs" fullname="TestQDoc::Test::methodWithEnDashInItsDocs" href="testqdoc-test.html#methodWithEnDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEnDashInItsDocs()"> + <description> + <para>This method has en dashes in its documentation – as you'll find represented by <teletype type="highlighted">--</teletype> 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:</para> + <code>for (int i = 42; i > 0; --i) + // Do something cool during countdown.</code> + <para>...as it would be silly if this would output –i instead of <teletype type="highlighted">--i</teletype>.</para> + <para>-----------------------------------------------------------------------</para> + <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:</para> + <para>– You can also start a new paragraph with an en dash, if you want to.</para> + <see-also>methodWithEnDashInItsDocs</see-also> + </description> + </function> + <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void obsoleteMember()"> + <description> + <para>Use <link raw="someFunction()" href="testqdoc-test.html#someFunction" type="function">someFunction()</link> instead.</para> + </description> + </function> + <function name="operator++" fullname="TestQDoc::Test::operator++" href="testqdoc-test-obsolete.html#operator-2b-2b" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator++()"> + <description/> + </function> + <function name="operator--" fullname="TestQDoc::Test::operator--" href="testqdoc-test-obsolete.html#operator--" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator--()"> + <description/> + </function> + <function name="operator=" fullname="TestQDoc::Test::operator=" href="testqdoc-test.html#operator-eq" status="active" access="public" location="testcpp.h" documented="true" meta="move-assign" type="TestQDoc::Test &" signature="TestQDoc::Test & operator=(TestQDoc::Test &&other)" groups="testgroup"> + <parameter type="TestQDoc::Test &&" name="other" default=""/> + <description> + <para>The move assignment operator is deleted. <argument>other</argument> cannot be moved from.</para> + </description> + </function> + <function name="operator==" href="testqdoc-test.html#operator-eq-eq" status="active" access="public" location="testcpp.h" documented="true" related="2" meta="plain" type="bool" signature="bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)"> + <parameter type="const TestQDoc::Test &" name="lhs" default=""/> + <parameter type="const TestQDoc::Test &" name="rhs" default=""/> + <description> + <para>Returns true if <argument>lhs</argument> and <argument>rhs</argument> are equal.</para> + </description> + </function> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" documented="true" meta="plain" type="void" signature="void overload()"> + <description/> + </function> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" documented="true" since="Test 1.2" meta="plain" overload="true" overload-number="1" type="void" signature="void overload(bool b)"> + <parameter type="bool" name="b" default=""/> + <description/> + </function> + <function name="someFunction" fullname="TestQDoc::Test::someFunction" href="testqdoc-test.html#someFunction" status="active" access="public" location="testcpp.h" documented="true" since="Test 1.0" meta="plain" type="int" signature="int someFunction(int, int v)"> + <parameter type="int" name="" default=""/> + <parameter type="int" name="v" default="0"/> + <description> + <para>Function that takes a parameter <argument>v</argument>. Also returns the value of <argument>v</argument>.</para> + </description> + </function> + <function name="someFunctionDefaultArg" fullname="TestQDoc::Test::someFunctionDefaultArg" href="testqdoc-test.html#someFunctionDefaultArg" threadsafety="non-reentrant" status="active" access="public" location="testcpp.h" documented="true" since="2.0" meta="plain" const="true" type="void" signature="void someFunctionDefaultArg(int i, bool b) const" groups="testgroup"> + <parameter type="int" name="i" default=""/> + <parameter type="bool" name="b" default="false"/> + <description> + <para>Function that takes a parameter <argument>i</argument> and <argument>b</argument>.</para> + </description> + </function> + <function name="virtualFun" fullname="TestQDoc::Test::virtualFun" href="testqdoc-test.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" type="void" signature="void virtualFun()"> + <description> + <para>Function that must be reimplemented.</para> + </description> + </function> + <typedef name="SomeType" fullname="TestQDoc::Test::SomeType" href="testqdoc-test.html#SomeType-typedef" status="active" access="public" location="testcpp.h" documented="true"> + <description> + <brief>A typedef.</brief> + </description> + </typedef> + </class> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc-testderived.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc-testderived.webxml new file mode 100644 index 000000000..197cacd1d --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc-testderived.webxml @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <class name="TestDerived" fullname="TestQDoc::TestDerived" href="testqdoc-testderived.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" bases="TestQDoc::Test" module="TestCPP" brief="A class in a namespace, derived from Test"> + <description> + <brief>A class in a namespace, derived from <link raw="Test" href="testqdoc-test.html" type="class">Test</link>.</brief> + </description> + <function name="bindableProp" fullname="TestQDoc::TestDerived::bindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="bindableProp" type="QBindable<QString>" signature="QBindable<QString> bindableProp()"> + <description> + <see-also>setBindableProp()</see-also> + </description> + </function> + <function name="bindablePropChanged" fullname="TestQDoc::TestDerived::bindablePropChanged" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="signal" associated-property="bindableProp" type="void" signature="void bindablePropChanged()"> + <description/> + </function> + <function name="boolProp" fullname="TestQDoc::TestDerived::boolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="boolProp" type="bool" signature="bool boolProp()"> + <description> + <see-also>setBoolProp()</see-also> + </description> + </function> + <function name="boolPropChanged" fullname="TestQDoc::TestDerived::boolPropChanged" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="signal" associated-property="boolProp" type="void" signature="void boolPropChanged()"> + <description/> + </function> + <function name="emitSomething" fullname="TestQDoc::TestDerived::emitSomething" href="testqdoc-testderived.html#emitSomething" status="active" access="public" location="testcpp.h" documented="true" meta="signal" type="void" signature="void emitSomething()"> + <description> + <para>Emitted when things happen.</para> + </description> + </function> + <function name="getInt" fullname="TestQDoc::TestDerived::getInt" href="testqdoc-testderived.html#intProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="intProp" type="int *" signature="int * getInt()"> + <description/> + </function> + <function name="id" fullname="TestQDoc::TestDerived::id" href="testqdoc-testderived.html#id" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="int" signature="int id() override"> + <description/> + </function> + <function name="invokeMe" fullname="TestQDoc::TestDerived::invokeMe" href="testqdoc-testderived.html#invokeMe" status="active" access="public" location="testcpp.h" documented="true" meta="plain" const="true" type="void" brief="Something invokable" signature="void invokeMe() const"> + <description> + <brief>Something invokable.</brief> + </description> + </function> + <function name="name" fullname="TestQDoc::TestDerived::name" href="testqdoc-testderived.html#name-prop" status="active" access="public" location="testcpp.h" meta="plain" const="true" associated-property="name" type="const QString *" signature="const QString * name() const"> + <description/> + </function> + <function name="resetBoolProp" fullname="TestQDoc::TestDerived::resetBoolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="boolProp" type="void" signature="void resetBoolProp()"> + <description/> + </function> + <function name="setBindableProp" fullname="TestQDoc::TestDerived::setBindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="bindableProp" type="void" signature="void setBindableProp(const QString &s)"> + <parameter type="const QString &" name="s" default=""/> + <description> + <see-also>bindableProp()</see-also> + </description> + </function> + <function name="setBoolProp" fullname="TestQDoc::TestDerived::setBoolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="boolProp" type="void" signature="void setBoolProp(bool b)"> + <parameter type="bool" name="b" default=""/> + <description> + <see-also>boolProp()</see-also> + </description> + </function> + <function name="someProp" fullname="TestQDoc::TestDerived::someProp" href="testqdoc-testderived.html#someProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="someProp" type="const QString &" signature="const QString & someProp()"> + <description/> + </function> + <function name="someValue" fullname="TestQDoc::TestDerived::someValue" href="testqdoc-testderived.html#someValue" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::TestDerived::NotTypedef" signature="TestQDoc::TestDerived::NotTypedef someValue()"> + <description> + <para>Returns a value using an aliases type.</para> + </description> + </function> + <function name="staticObsoleteMember" fullname="TestQDoc::TestDerived::staticObsoleteMember" href="testqdoc-testderived-obsolete.html#staticObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" static="true" type="void" signature="void staticObsoleteMember()"> + <description> + <para>Static obsolete method.</para> + </description> + </function> + <function name="virtualFun" fullname="TestQDoc::TestDerived::virtualFun" href="testqdoc-testderived.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="void" signature="void virtualFun() override"> + <description/> + </function> + <typedef name="DerivedType" fullname="TestQDoc::TestDerived::DerivedType" href="testqdoc-testderived.html#DerivedType-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="Test::SomeType"> + <description> + <para>An aliased typedef.</para> + </description> + </typedef> + <typedef name="NotTypedef" fullname="TestQDoc::TestDerived::NotTypedef" href="testqdoc-testderived.html#NotTypedef-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="int"> + <description> + <para>I'm an alias, not a typedef.</para> + </description> + </typedef> + <property name="bindableProp" fullname="TestQDoc::TestDerived::bindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" documented="true" bindable="true"> + <getter name="bindableProp"/> + <setter name="setBindableProp"/> + <notifier name="bindablePropChanged"/> + <description> + <para>Some property.</para> + <see-also> + <link raw="someProp" href="testqdoc-testderived.html#someProp-prop" type="function">someProp</link> + </see-also> + </description> + </property> + <property name="boolProp" fullname="TestQDoc::TestDerived::boolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" documented="true"> + <getter name="boolProp"/> + <setter name="setBoolProp"/> + <resetter name="resetBoolProp"/> + <notifier name="boolPropChanged"/> + <description> + <para>A boolean property.</para> + </description> + </property> + <property name="intProp" fullname="TestQDoc::TestDerived::intProp" href="testqdoc-testderived.html#intProp-prop" status="active" access="public" location="testcpp.h" documented="true" writable="false"> + <getter name="getInt"/> + <description> + <para>An integer property.</para> + </description> + </property> + <property name="name" fullname="TestQDoc::TestDerived::name" href="testqdoc-testderived.html#name-prop" status="active" access="public" location="testcpp.h" documented="true" writable="false" brief="Name"> + <getter name="name"/> + <description> + <brief>This property holds a name..</brief> + </description> + </property> + <property name="someProp" fullname="TestQDoc::TestDerived::someProp" href="testqdoc-testderived.html#someProp-prop" status="active" access="public" location="testcpp.h" documented="true" bindable="true" writable="false"> + <getter name="someProp"/> + <description> + <para>Another property.</para> + </description> + </property> + </class> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc.webxml new file mode 100644 index 000000000..dfd9eeb9d --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testqdoc.webxml @@ -0,0 +1,253 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <namespace name="TestQDoc" href="testqdoc.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" module="TestCPP" brief="A namespace"> + <contents name="usage" title="Usage" level="1"/> + <description> + <brief>A namespace.</brief> + <section id="usage"> + <heading level="1">Usage</heading> + <para>This namespace is for testing QDoc output.</para> + </section> + </description> + <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="0" since="Test 0.9" meta="macrowithoutparams" signature="QDOCTEST_MACRO"> + <description/> + </function> + <class threadsafety="reentrant" name="Test" fullname="TestQDoc::Test" href="testqdoc-test.html" status="active" access="public" location="testcpp.h" since="1.1" documented="true" groups="cpptypes,testgroup" module="TestCPP" brief="A class in a namespace"> + <description> + <brief>A class in a namespace.</brief> + </description> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" brief="A macro with argument x" signature="QDOCTEST_MACRO2(int &x)" groups="testgroup"> + <parameter type="int &" name="x" default=""/> + <description> + <brief>A macro with argument <argument>x</argument>.</brief> + </description> + </function> + <function name="Test" fullname="TestQDoc::Test::Test" href="testqdoc-test.html#Test" status="active" access="public" location="testcpp.h" documented="true" meta="constructor" signature="Test()"> + <description> + <para>The constructor is deleted.</para> + </description> + </function> + <function name="anotherObsoleteMember" fullname="TestQDoc::Test::anotherObsoleteMember" href="testqdoc-test-obsolete.html#anotherObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void anotherObsoleteMember()"> + <description> + <para>Use <link raw="obsoleteMember()" href="testqdoc-test.html#obsoleteMember" type="function">obsoleteMember()</link> instead.</para> + </description> + </function> + <function name="deprecatedMember" fullname="TestQDoc::Test::deprecatedMember" href="testqdoc-test-obsolete.html#deprecatedMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void deprecatedMember()"> + <description> + <para>Use <link raw="someFunction()" href="testqdoc-test.html#someFunction" type="function">someFunction()</link> instead.</para> + </description> + </function> + <function name="funcPtr" fullname="TestQDoc::Test::funcPtr" href="testqdoc-test.html#funcPtr" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void (*)(bool)" signature="void (*)(bool) funcPtr(bool b, const char *s)"> + <parameter type="bool" name="b" default=""/> + <parameter type="const char *" name="s" default=""/> + <description> + <para>Returns a pointer to a function that takes a boolean. Uses <argument>b</argument> and <argument>s</argument>.</para> + </description> + </function> + <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"> + <description> + <brief>An inline function, documented using the \fn QDoc command.</brief> + </description> + </function> + <function name="methodWithEmDashInItsDocs" fullname="TestQDoc::Test::methodWithEmDashInItsDocs" href="testqdoc-test.html#methodWithEmDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEmDashInItsDocs()"> + <description> + <para>This method has em dashes in its documentation—as you'll find represented by <teletype type="highlighted">---</teletype> 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.</para> + <para>-----------------------------------------------------------------------</para> + <para>People can still add a bunch of dashes, though, without QDoc replacing them all with a series of em dashes.</para> + <para>—You can also start a new paragraph with an em dash, if you want to.</para> + <see-also> + <link raw="methodWithEnDashInItsDocs" href="testqdoc-test.html#methodWithEnDashInItsDocs" type="function">methodWithEnDashInItsDocs</link> + </see-also> + </description> + </function> + <function name="methodWithEnDashInItsDocs" fullname="TestQDoc::Test::methodWithEnDashInItsDocs" href="testqdoc-test.html#methodWithEnDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEnDashInItsDocs()"> + <description> + <para>This method has en dashes in its documentation – as you'll find represented by <teletype type="highlighted">--</teletype> 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:</para> + <code>for (int i = 42; i > 0; --i) + // Do something cool during countdown.</code> + <para>...as it would be silly if this would output –i instead of <teletype type="highlighted">--i</teletype>.</para> + <para>-----------------------------------------------------------------------</para> + <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:</para> + <para>– You can also start a new paragraph with an en dash, if you want to.</para> + <see-also>methodWithEnDashInItsDocs</see-also> + </description> + </function> + <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void obsoleteMember()"> + <description> + <para>Use <link raw="someFunction()" href="testqdoc-test.html#someFunction" type="function">someFunction()</link> instead.</para> + </description> + </function> + <function name="operator++" fullname="TestQDoc::Test::operator++" href="testqdoc-test-obsolete.html#operator-2b-2b" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator++()"> + <description/> + </function> + <function name="operator--" fullname="TestQDoc::Test::operator--" href="testqdoc-test-obsolete.html#operator--" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator--()"> + <description/> + </function> + <function name="operator=" fullname="TestQDoc::Test::operator=" href="testqdoc-test.html#operator-eq" status="active" access="public" location="testcpp.h" documented="true" meta="move-assign" type="TestQDoc::Test &" signature="TestQDoc::Test & operator=(TestQDoc::Test &&other)" groups="testgroup"> + <parameter type="TestQDoc::Test &&" name="other" default=""/> + <description> + <para>The move assignment operator is deleted. <argument>other</argument> cannot be moved from.</para> + </description> + </function> + <function name="operator==" href="testqdoc-test.html#operator-eq-eq" status="active" access="public" location="testcpp.h" documented="true" related="2" meta="plain" type="bool" signature="bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)"> + <parameter type="const TestQDoc::Test &" name="lhs" default=""/> + <parameter type="const TestQDoc::Test &" name="rhs" default=""/> + <description> + <para>Returns true if <argument>lhs</argument> and <argument>rhs</argument> are equal.</para> + </description> + </function> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" documented="true" meta="plain" type="void" signature="void overload()"> + <description/> + </function> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" documented="true" since="Test 1.2" meta="plain" overload="true" overload-number="1" type="void" signature="void overload(bool b)"> + <parameter type="bool" name="b" default=""/> + <description/> + </function> + <function name="someFunction" fullname="TestQDoc::Test::someFunction" href="testqdoc-test.html#someFunction" status="active" access="public" location="testcpp.h" documented="true" since="Test 1.0" meta="plain" type="int" signature="int someFunction(int, int v)"> + <parameter type="int" name="" default=""/> + <parameter type="int" name="v" default="0"/> + <description> + <para>Function that takes a parameter <argument>v</argument>. Also returns the value of <argument>v</argument>.</para> + </description> + </function> + <function name="someFunctionDefaultArg" fullname="TestQDoc::Test::someFunctionDefaultArg" href="testqdoc-test.html#someFunctionDefaultArg" threadsafety="non-reentrant" status="active" access="public" location="testcpp.h" documented="true" since="2.0" meta="plain" const="true" type="void" signature="void someFunctionDefaultArg(int i, bool b) const" groups="testgroup"> + <parameter type="int" name="i" default=""/> + <parameter type="bool" name="b" default="false"/> + <description> + <para>Function that takes a parameter <argument>i</argument> and <argument>b</argument>.</para> + </description> + </function> + <function name="virtualFun" fullname="TestQDoc::Test::virtualFun" href="testqdoc-test.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" type="void" signature="void virtualFun()"> + <description> + <para>Function that must be reimplemented.</para> + </description> + </function> + <typedef name="SomeType" fullname="TestQDoc::Test::SomeType" href="testqdoc-test.html#SomeType-typedef" status="active" access="public" location="testcpp.h" documented="true"> + <description> + <brief>A typedef.</brief> + </description> + </typedef> + </class> + <class name="TestDerived" fullname="TestQDoc::TestDerived" href="testqdoc-testderived.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" bases="TestQDoc::Test" module="TestCPP" brief="A class in a namespace, derived from Test"> + <description> + <brief>A class in a namespace, derived from <link raw="Test" href="testqdoc-test.html" type="class">Test</link>.</brief> + </description> + <function name="bindableProp" fullname="TestQDoc::TestDerived::bindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="bindableProp" type="QBindable<QString>" signature="QBindable<QString> bindableProp()"> + <description> + <see-also>setBindableProp()</see-also> + </description> + </function> + <function name="bindablePropChanged" fullname="TestQDoc::TestDerived::bindablePropChanged" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="signal" associated-property="bindableProp" type="void" signature="void bindablePropChanged()"> + <description/> + </function> + <function name="boolProp" fullname="TestQDoc::TestDerived::boolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="boolProp" type="bool" signature="bool boolProp()"> + <description> + <see-also>setBoolProp()</see-also> + </description> + </function> + <function name="boolPropChanged" fullname="TestQDoc::TestDerived::boolPropChanged" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="signal" associated-property="boolProp" type="void" signature="void boolPropChanged()"> + <description/> + </function> + <function name="emitSomething" fullname="TestQDoc::TestDerived::emitSomething" href="testqdoc-testderived.html#emitSomething" status="active" access="public" location="testcpp.h" documented="true" meta="signal" type="void" signature="void emitSomething()"> + <description> + <para>Emitted when things happen.</para> + </description> + </function> + <function name="getInt" fullname="TestQDoc::TestDerived::getInt" href="testqdoc-testderived.html#intProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="intProp" type="int *" signature="int * getInt()"> + <description/> + </function> + <function name="id" fullname="TestQDoc::TestDerived::id" href="testqdoc-testderived.html#id" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="int" signature="int id() override"> + <description/> + </function> + <function name="invokeMe" fullname="TestQDoc::TestDerived::invokeMe" href="testqdoc-testderived.html#invokeMe" status="active" access="public" location="testcpp.h" documented="true" meta="plain" const="true" type="void" brief="Something invokable" signature="void invokeMe() const"> + <description> + <brief>Something invokable.</brief> + </description> + </function> + <function name="name" fullname="TestQDoc::TestDerived::name" href="testqdoc-testderived.html#name-prop" status="active" access="public" location="testcpp.h" meta="plain" const="true" associated-property="name" type="const QString *" signature="const QString * name() const"> + <description/> + </function> + <function name="resetBoolProp" fullname="TestQDoc::TestDerived::resetBoolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="boolProp" type="void" signature="void resetBoolProp()"> + <description/> + </function> + <function name="setBindableProp" fullname="TestQDoc::TestDerived::setBindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="bindableProp" type="void" signature="void setBindableProp(const QString &s)"> + <parameter type="const QString &" name="s" default=""/> + <description> + <see-also>bindableProp()</see-also> + </description> + </function> + <function name="setBoolProp" fullname="TestQDoc::TestDerived::setBoolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" meta="slot" associated-property="boolProp" type="void" signature="void setBoolProp(bool b)"> + <parameter type="bool" name="b" default=""/> + <description> + <see-also>boolProp()</see-also> + </description> + </function> + <function name="someProp" fullname="TestQDoc::TestDerived::someProp" href="testqdoc-testderived.html#someProp-prop" status="active" access="public" location="testcpp.h" meta="plain" associated-property="someProp" type="const QString &" signature="const QString & someProp()"> + <description/> + </function> + <function name="someValue" fullname="TestQDoc::TestDerived::someValue" href="testqdoc-testderived.html#someValue" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::TestDerived::NotTypedef" signature="TestQDoc::TestDerived::NotTypedef someValue()"> + <description> + <para>Returns a value using an aliases type.</para> + </description> + </function> + <function name="staticObsoleteMember" fullname="TestQDoc::TestDerived::staticObsoleteMember" href="testqdoc-testderived-obsolete.html#staticObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" static="true" type="void" signature="void staticObsoleteMember()"> + <description> + <para>Static obsolete method.</para> + </description> + </function> + <function name="virtualFun" fullname="TestQDoc::TestDerived::virtualFun" href="testqdoc-testderived.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="void" signature="void virtualFun() override"> + <description/> + </function> + <typedef name="DerivedType" fullname="TestQDoc::TestDerived::DerivedType" href="testqdoc-testderived.html#DerivedType-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="Test::SomeType"> + <description> + <para>An aliased typedef.</para> + </description> + </typedef> + <typedef name="NotTypedef" fullname="TestQDoc::TestDerived::NotTypedef" href="testqdoc-testderived.html#NotTypedef-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="int"> + <description> + <para>I'm an alias, not a typedef.</para> + </description> + </typedef> + <property name="bindableProp" fullname="TestQDoc::TestDerived::bindableProp" href="testqdoc-testderived.html#bindableProp-prop" status="active" access="public" location="testcpp.h" documented="true" bindable="true"> + <getter name="bindableProp"/> + <setter name="setBindableProp"/> + <notifier name="bindablePropChanged"/> + <description> + <para>Some property.</para> + <see-also> + <link raw="someProp" href="testqdoc-testderived.html#someProp-prop" type="function">someProp</link> + </see-also> + </description> + </property> + <property name="boolProp" fullname="TestQDoc::TestDerived::boolProp" href="testqdoc-testderived.html#boolProp-prop" status="active" access="public" location="testcpp.h" documented="true"> + <getter name="boolProp"/> + <setter name="setBoolProp"/> + <resetter name="resetBoolProp"/> + <notifier name="boolPropChanged"/> + <description> + <para>A boolean property.</para> + </description> + </property> + <property name="intProp" fullname="TestQDoc::TestDerived::intProp" href="testqdoc-testderived.html#intProp-prop" status="active" access="public" location="testcpp.h" documented="true" writable="false"> + <getter name="getInt"/> + <description> + <para>An integer property.</para> + </description> + </property> + <property name="name" fullname="TestQDoc::TestDerived::name" href="testqdoc-testderived.html#name-prop" status="active" access="public" location="testcpp.h" documented="true" writable="false" brief="Name"> + <getter name="name"/> + <description> + <brief>This property holds a name..</brief> + </description> + </property> + <property name="someProp" fullname="TestQDoc::TestDerived::someProp" href="testqdoc-testderived.html#someProp-prop" status="active" access="public" location="testcpp.h" documented="true" bindable="true" writable="false"> + <getter name="someProp"/> + <description> + <para>Another property.</para> + </description> + </property> + </class> + </namespace> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testtagfile.tags b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testtagfile.tags new file mode 100644 index 000000000..f68dffed6 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testtagfile.tags @@ -0,0 +1,500 @@ +<?xml version="1.0" encoding="UTF-8"?> +<tagfile> + <compound kind="class"> + <name>QDoc.Test.AbstractParent</name> + <filename>qml-qdoc-test-abstractparent.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>name</name> + <anchorfile>qml-qdoc-test-abstractparent.html</anchorfile> + <anchor>name-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>name</name> + <anchorfile>qml-qdoc-test-abstractparent.html</anchorfile> + <anchor>name-method</anchor> + <arglist>(Child child, name)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>rear</name> + <anchorfile>qml-qdoc-test-abstractparent.html</anchorfile> + <anchor>rear-method</anchor> + <arglist>(Child child, var method)</arglist> + </member> + </compound> + <compound kind="class"> + <name>QDoc.Test.Child</name> + <filename>qml-qdoc-test-child.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>name</name> + <anchorfile>qml-qdoc-test-child.html</anchorfile> + <anchor>name-method</anchor> + <arglist>(Child child, name)</arglist> + </member> + </compound> + <compound kind="namespace"> + <name>CrossModuleRef</name> + <filename>crossmoduleref.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>documentMe</name> + <anchorfile>crossmoduleref.html</anchorfile> + <anchor>documentMe</anchor> + <arglist>()</arglist> + </member> + </compound> + <compound kind="class"> + <name>QDoc.Test.DocTest</name> + <filename>qml-qdoc-test-doctest.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>completed</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>completed-signal</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>fail</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>fail-method</anchor> + <arglist>(message)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>fail_hard</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>fail_hard-method</anchor> + <arglist>(msg, option)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>foo</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>foo-signal</anchor> + <arglist>(var bar)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>itsHappening</name> + <anchorfile>qml-qdoc-test-doctest.html</anchorfile> + <anchor>itsHappening-signal</anchor> + <arglist>(bool really)</arglist> + </member> + </compound> + <compound kind="class"> + <name>Test.NoVer.DocTest</name> + <filename>qml-test-nover-doctest.html</filename> + </compound> + <compound kind="class"> + <name>QDoc.Test.OldType</name> + <filename>qml-qdoc-test-oldtype.html</filename> + </compound> + <compound kind="class"> + <name>UIComponents.ProgressBar</name> + <filename>qml-uicomponents-progressbar.html</filename> + </compound> + <compound kind="class"> + <name>SeenClass</name> + <filename>seenclass.html</filename> + </compound> + <compound kind="class"> + <name>UIComponents.Switch</name> + <filename>qml-uicomponents-switch.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>toggle</name> + <anchorfile>qml-uicomponents-switch.html</anchorfile> + <anchor>toggle-method</anchor> + <arglist>()</arglist> + </member> + </compound> + <compound kind="class"> + <name>UIComponents.TabWidget</name> + <filename>qml-uicomponents-tabwidget.html</filename> + </compound> + <compound kind="namespace"> + <name>TestQDoc</name> + <filename>testqdoc.html</filename> + <class>TestQDoc::Test</class> + <class>TestQDoc::TestDerived</class> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>QDOCTEST_MACRO</name> + <anchorfile>testqdoc.html</anchorfile> + <anchor>QDOCTEST_MACRO</anchor> + <arglist>QDOCTEST_MACRO</arglist> + </member> + </compound> + <compound kind="class"> + <name>TestQDoc::Test</name> + <filename>testqdoc-test.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>QDOCTEST_MACRO2</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>QDOCTEST_MACRO2</anchor> + <arglist>(int &x)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>Test</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>Test</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>TestQDoc::Test &</type> + <name>operator++</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>operator-2b-2b</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>TestQDoc::Test &</type> + <name>operator--</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>operator--</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>TestQDoc::Test &</type> + <name>operator=</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>operator-eq</anchor> + <arglist>(TestQDoc::Test &&other)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>bool</type> + <name>operator==</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>operator-eq-eq</anchor> + <arglist>(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>int</type> + <name>someFunction</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>someFunction</anchor> + <arglist>(int, int v)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void (*)(bool)</type> + <name>funcPtr</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>funcPtr</anchor> + <arglist>(*)(bool) funcPtr(bool b, const char *s)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>anotherObsoleteMember</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>anotherObsoleteMember</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>deprecatedMember</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>deprecatedMember</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>inlineFunction</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>inlineFunction</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>methodWithEmDashInItsDocs</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>methodWithEmDashInItsDocs</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>methodWithEnDashInItsDocs</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>methodWithEnDashInItsDocs</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>obsoleteMember</name> + <anchorfile>testqdoc-test-obsolete.html</anchorfile> + <anchor>obsoleteMember</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="protected" virtualness="non" static="no"> + <type>void</type> + <name>overload</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>overload</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="protected" virtualness="non" static="no"> + <type>void</type> + <name>overload</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>overload-1</anchor> + <arglist>(bool b)</arglist> + </member> + <member kind="function" protection="public" virtualness="virtual" static="no"> + <type>virtual void</type> + <name>virtualFun</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>virtualFun</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>someFunctionDefaultArg</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>someFunctionDefaultArg</anchor> + <arglist>(int i, bool b) const const</arglist> + </member> + <member kind="typedef" type=""> + <name>SomeType</name> + <anchorfile>testqdoc-test.html</anchorfile> + <anchor>SomeType-typedef</anchor> + <arglist></arglist> + </member> + </compound> + <compound kind="class"> + <name>TestQDoc::TestDerived</name> + <filename>testqdoc-testderived.html</filename> + <base>Test</base> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>QBindable<QString></type> + <name>bindableProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>bindableProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>TestQDoc::TestDerived::NotTypedef</type> + <name>someValue</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>someValue</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>bool</type> + <name>boolProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>const QString &</type> + <name>someProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>someProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>int *</type> + <name>getInt</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>intProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="virtual" static="no"> + <type>virtual int</type> + <name>id</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>id</anchor> + <arglist>() override</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>bindablePropChanged</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>bindableProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>boolPropChanged</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>emitSomething</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>emitSomething</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>resetBoolProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>setBindableProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>bindableProp-prop</anchor> + <arglist>(const QString &s)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>setBoolProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist>(bool b)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="yes"> + <type>void</type> + <name>staticObsoleteMember</name> + <anchorfile>testqdoc-testderived-obsolete.html</anchorfile> + <anchor>staticObsoleteMember</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="virtual" static="no"> + <type>virtual void</type> + <name>virtualFun</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>virtualFun</anchor> + <arglist>() override</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>const QString *</type> + <name>name</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>name-prop</anchor> + <arglist>() const const</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>void</type> + <name>invokeMe</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>invokeMe</anchor> + <arglist>() const const</arglist> + </member> + <member kind="typedef" type=""> + <name>DerivedType</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>DerivedType-typedef</anchor> + <arglist></arglist> + </member> + <member kind="typedef" type=""> + <name>NotTypedef</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>NotTypedef-typedef</anchor> + <arglist></arglist> + </member> + <member kind="property" type="QString"> + <name>bindableProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>bindableProp-prop</anchor> + <arglist></arglist> + </member> + <member kind="property" type="bool"> + <name>boolProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>boolProp-prop</anchor> + <arglist></arglist> + </member> + <member kind="property" type="int*"> + <name>intProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>intProp-prop</anchor> + <arglist></arglist> + </member> + <member kind="property" type="const QString*"> + <name>name</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>name-prop</anchor> + <arglist></arglist> + </member> + <member kind="property" type="QString"> + <name>someProp</name> + <anchorfile>testqdoc-testderived.html</anchorfile> + <anchor>someProp-prop</anchor> + <arglist></arglist> + </member> + </compound> + <compound kind="class"> + <name>TheModule.TheType</name> + <filename>qml-themodule-thetype.html</filename> + </compound> + <compound kind="class"> + <name>QDoc.Test.Type</name> + <filename>qml-qdoc-test-type.html</filename> + <member kind="function" protection="public" virtualness="non" static="no"> + <type>Type</type> + <name>copy</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>copy-method</anchor> + <arglist>(a)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>completed</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>completed-signal</anchor> + <arglist>(int status)</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>configured</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>configured-signal</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>deprecatedMethod</name> + <anchorfile>qml-qdoc-test-type-obsolete.html</anchorfile> + <anchor>deprecatedMethod-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>disable</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>disable-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>enable</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>enable-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>futureDeprecated</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>futureDeprecated-method</anchor> + <arglist>()</arglist> + </member> + <member kind="function" protection="public" virtualness="non" static="no"> + <type></type> + <name>group.created</name> + <anchorfile>qml-qdoc-test-type.html</anchorfile> + <anchor>group.created-signal</anchor> + <arglist>()</arglist> + </member> + </compound> + <compound kind="class"> + <name>Test.NoVer.TypeNoVersion</name> + <filename>qml-test-nover-typenoversion.html</filename> + </compound> + <compound kind="class"> + <name>QDoc.Test.YetAnotherChild</name> + <filename>qml-qdoc-test-yetanotherchild.html</filename> + </compound> +</tagfile> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/themodule-qmlmodule.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/themodule-qmlmodule.webxml new file mode 100644 index 000000000..5d24b3077 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/themodule-qmlmodule.webxml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document/> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/uicomponents-qmlmodule.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/uicomponents-qmlmodule.webxml new file mode 100644 index 000000000..5d24b3077 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/uicomponents-qmlmodule.webxml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document/> +</WebXML> |
