diff options
| author | Qt Forward Merge Bot <qt_forward_merge_bot@qt-project.org> | 2020-02-15 03:03:34 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-02-18 00:08:50 +0100 |
| commit | fab885ac1b5e5d3c130c033e4a1234e985179486 (patch) | |
| tree | 94bf9028ad4cc75559e34e2b526f15c600c47b6a /tests | |
| parent | 4776efd26bf95d21b7cc3137ecc2d81a6ccd2b80 (diff) | |
Merge remote-tracking branch 'origin/5.14' into 5.15
Change-Id: I98eaf748fdfb34f32d187718459327b8eef9c54b
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'tests')
39 files changed, 1252 insertions, 35 deletions
diff --git a/tests/auto/qdoc/generatedoutput/examples-qhp.qdocconf b/tests/auto/qdoc/generatedoutput/examples-qhp.qdocconf index 816d1d1a4..b4598476e 100644 --- a/tests/auto/qdoc/generatedoutput/examples-qhp.qdocconf +++ b/tests/auto/qdoc/generatedoutput/examples-qhp.qdocconf @@ -1,6 +1,8 @@ # QML test includes a documented example include(testqml.qdocconf) +examplesinstallpath = test + # Configure .qhp generation qhp.projects = Test diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/test-componentset-example.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/test-componentset-example.xml index ac93617a2..2b442d1dd 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/test-componentset-example.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/test-componentset-example.xml @@ -5,7 +5,8 @@ <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: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.</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> @@ -33,4 +34,14 @@ An aliased property of type <@type>int</@type><@op>.</@op&g <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 <db:link xlink:href="">QML commands</db:link> may be placed inside C++ classes to define the public API of the QML type.</db:para> </db:section> +<db:para>Files:</db:para> +<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:itemizedlist> </db:article> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/examples-manifest.xml b/tests/auto/qdoc/generatedoutput/expected_output/examples-manifest.xml index 330923033..7f206d0e8 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/examples-manifest.xml +++ b/tests/auto/qdoc/generatedoutput/expected_output/examples-manifest.xml @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="UTF-8"?> <instructionals module="Test"> <examples> - <example name="QML Documentation Example" docUrl="qthelp://org.qt-project.test.001/test/test-componentset-example.html" isTest="true"> - <description><![CDATA[No description available]]></description> - <tags>documentation,qml,test</tags> + <example name="QML Documentation Example" docUrl="qthelp://org.qt-project.test.001/test/test-componentset-example.html" projectPath="tutorials/componentset/componentset.pro" isTest="true"> + <description><![CDATA[Example for documenting QML types.]]></description> + <tags>documentation,qml,sample,test</tags> </example> </examples> </instructionals> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/html/test-componentset-example.webxml b/tests/auto/qdoc/generatedoutput/expected_output/html/test-componentset-example.webxml index 377c49980..515ef7bf1 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/html/test-componentset-example.webxml +++ b/tests/auto/qdoc/generatedoutput/expected_output/html/test-componentset-example.webxml @@ -1,12 +1,13 @@ <?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="" module="Test"> + <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="" module="Test" 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.</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> @@ -32,6 +33,29 @@ An aliased property of type int.</code> <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> + </list> </description> </page> </document> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/index.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/index.html new file mode 100644 index 000000000..d1fb02484 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/index.html @@ -0,0 +1,28 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- includefromparent.qdoc --> + <title>doc index | Test</title> +</head> +<body> +<h1 class="title">doc index</h1> +<span class="subtitle"></span> +<!-- $$$index.html-description --> +<div class="descr"> <a name="details"></a> +<a name="c-classes"></a> +<h2 id="c-classes">C++ Classes</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName"><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="even topAlign"><td class="tblName"><p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p></td><td class="tblDescr"><p>A derived class in a namespace</p></td></tr> +</table></div> +<a name="qml-types"></a> +<h2 id="qml-types">QML Types</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName"><p><a href="qml-qdoc-test-abstractparent.html">AbstractParent</a></p></td><td class="tblDescr"><p>Abstract base QML type</p></td></tr> +</table></div> +<p>Test include file that is part of the sourcedirs.</p> +</div> +<!-- @@@index.html --> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qdoc-test-qmlmodule.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qdoc-test-qmlmodule.html new file mode 100644 index 000000000..6a513e987 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qdoc-test-qmlmodule.html @@ -0,0 +1,23 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <title>Test</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<span class="subtitle"></span> +<!-- $$$QDoc.Test-description --> +<div class="descr"> <a name="details"></a> +</div> +<!-- @@@QDoc.Test --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName"><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"><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"><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"><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"><p><a href="qml-int.html">int</a></p></td><td class="tblDescr"><p>An integer basic type</p></td></tr> +</table></div> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-int.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-int.html new file mode 100644 index 000000000..651f840cb --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-int.html @@ -0,0 +1,23 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <title>int QML Basic Type | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></h3> +<ul> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">int QML Basic Type</h1> +<span class="subtitle"></span> +<!-- $$$int-description --> +<div class="descr"> <a name="details"></a> +</div> +<!-- @@@int --> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent-members.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent-members.html new file mode 100644 index 000000000..48c8fa485 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent-members.html @@ -0,0 +1,18 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <title>List of All Members for AbstractParent | Test</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">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"><b><b><a href="qml-qdoc-test-abstractparent.html#children-prop">children</a></b></b> : list<Child> [default]</li> +<li class="fn">void <b><b><a href="qml-qdoc-test-abstractparent.html#rear-method-1">rear</a></b></b>(<i>child</i>)</li> +<li class="fn">void <b><b><a href="qml-qdoc-test-abstractparent.html#rear-method">rear</a></b></b>(<i>child</i>)</li> +</ul> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent.html new file mode 100644 index 000000000..cbb0f36aa --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent.html @@ -0,0 +1,79 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <title>AbstractParent QML Type | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></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">AbstractParent QML Type</h1> +<span class="subtitle"></span> +<!-- $$$AbstractParent-brief --> +<p>Abstract base QML type. <a href="#details">More...</a></p> +<!-- @@@AbstractParent --> +<div class="table"><table class="alignedsummary"> +<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"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qdoc-test-child.html">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> +<a name="properties"></a> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn"><b><b><a href="qml-qdoc-test-abstractparent.html#children-prop">children</a></b></b> : list<Child></li> +</ul> +<a name="methods"></a> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn">void <b><b><a href="qml-qdoc-test-abstractparent.html#rear-method-1">rear</a></b></b>(<i>child</i>)</li> +<li class="fn">void <b><b><a href="qml-qdoc-test-abstractparent.html#rear-method">rear</a></b></b>(<i>child</i>)</li> +</ul> +<!-- $$$AbstractParent-description --> +<a name="details"></a> +<h2 id="details">Detailed Description</h2> +<!-- @@@AbstractParent --> +<h2>Property Documentation</h2> +<!-- $$$children --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="children-prop"> +<td class="tblQmlPropNode"><p> +<a name="children-prop"></a><span class="qmldefault">[default] </span><span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html">Child</a></span>></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Children of the type.</p> +<p>Test include file that is part of the sourcedirs.</p> +</div></div><!-- @@@children --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$rear$$$rear --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="rear-method-1"> +<td class="tblQmlFuncNode"><p> +<a name="rear-method-1"></a><span class="type">void</span> <span class="name">rear</span>(<i>child</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Do some abstract parenting on <i>child</i>.</p> +</div></div><!-- @@@rear --> +<br/> +<!-- $$$rear[overload1]$$$rear --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="rear-method"> +<td class="tblQmlFuncNode"><p> +<a name="rear-method"></a><span class="type">void</span> <span class="name">rear</span>(<i>child</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Do some abstract parenting on <i>child</i>.</p> +<p>Test include file that is part of the sourcedirs.</p> +</div></div><!-- @@@rear --> +<br/> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-child-members.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-child-members.html new file mode 100644 index 000000000..cedbad6bc --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-child-members.html @@ -0,0 +1,18 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <title>List of All Members for Child | Test</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">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"><b><b><a href="qml-qdoc-test-child.html#children-prop">children</a></b></b> : list<Child> [default]</li> +<li class="fn">void <b><b><a href="qml-qdoc-test-child.html#rear-method-1">rear</a></b></b>(<i>child</i>)</li> +<li class="fn">void <b><b><a href="qml-qdoc-test-child.html#rear-method">rear</a></b></b>(<i>child</i>)</li> +</ul> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-child.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-child.html new file mode 100644 index 000000000..b1775faa3 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-child.html @@ -0,0 +1,79 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <title>Child QML Type | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></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">Child QML Type</h1> +<span class="subtitle"></span> +<!-- $$$Child-brief --> +<p>A Child inheriting its parent. <a href="#details">More...</a></p> +<!-- @@@Child --> +<div class="table"><table class="alignedsummary"> +<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"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qdoc-test-abstractparent.html">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> +<a name="properties"></a> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn"><b><b><a href="qml-qdoc-test-child.html#children-prop">children</a></b></b> : list<Child></li> +</ul> +<a name="methods"></a> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn">void <b><b><a href="qml-qdoc-test-child.html#rear-method-1">rear</a></b></b>(<i>child</i>)</li> +<li class="fn">void <b><b><a href="qml-qdoc-test-child.html#rear-method">rear</a></b></b>(<i>child</i>)</li> +</ul> +<!-- $$$Child-description --> +<a name="details"></a> +<h2 id="details">Detailed Description</h2> +<!-- @@@Child --> +<h2>Property Documentation</h2> +<!-- $$$children --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="children-prop"> +<td class="tblQmlPropNode"><p> +<a name="children-prop"></a><span class="qmldefault">[default] </span><span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html">Child</a></span>></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Children of the type.</p> +<p>Test include file that is part of the sourcedirs.</p> +</div></div><!-- @@@children --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$rear$$$rear --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="rear-method-1"> +<td class="tblQmlFuncNode"><p> +<a name="rear-method-1"></a><span class="type">void</span> <span class="name">rear</span>(<i>child</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Do some abstract parenting on <i>child</i>.</p> +</div></div><!-- @@@rear --> +<br/> +<!-- $$$rear[overload1]$$$rear --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="rear-method"> +<td class="tblQmlFuncNode"><p> +<a name="rear-method"></a><span class="type">void</span> <span class="name">rear</span>(<i>child</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Do some abstract parenting on <i>child</i>.</p> +<p>Test include file that is part of the sourcedirs.</p> +</div></div><!-- @@@rear --> +<br/> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-doctest-members.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-doctest-members.html new file mode 100644 index 000000000..3048f9701 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-doctest-members.html @@ -0,0 +1,18 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- DocTest.qml --> + <title>List of All Members for DocTest | Test</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">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"><b><b><a href="qml-qdoc-test-doctest.html#active-prop">active</a></b></b> : bool</li> +<li class="fn"><b><b><a href="qml-qdoc-test-doctest.html#name-prop">name</a></b></b> : string</li> +<li class="fn"><b><b><a href="qml-qdoc-test-doctest.html#fail-method">fail</a></b></b>(<i>message</i>)</li> +</ul> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-doctest.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-doctest.html new file mode 100644 index 000000000..e1475d5fb --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-doctest.html @@ -0,0 +1,86 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- DocTest.qml --> + <title>DocTest QML Type | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></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> +<li class="level2"><a href="#introduction">Introduction</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">DocTest QML Type</h1> +<span class="subtitle"></span> +<!-- $$$DocTest-brief --> +<p>Represents a doc test case. <a href="#details">More...</a></p> +<!-- @@@DocTest --> +<div class="table"><table class="alignedsummary"> +<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> +<a name="properties"></a> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn"><b><b><a href="qml-qdoc-test-doctest.html#active-prop">active</a></b></b> : bool</li> +<li class="fn"><b><b><a href="qml-qdoc-test-doctest.html#name-prop">name</a></b></b> : string</li> +</ul> +<a name="methods"></a> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn"><b><b><a href="qml-qdoc-test-doctest.html#fail-method">fail</a></b></b>(<i>message</i>)</li> +</ul> +<!-- $$$DocTest-description --> +<a name="details"></a> +<h2 id="details">Detailed Description</h2> +<a name="introduction"></a> +<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"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="active-prop"> +<td class="tblQmlPropNode"><p> +<a name="active-prop"></a><span class="name">active</span> : <span class="type">bool</span></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">name</a>.</p> +</div></div><!-- @@@active --> +<br/> +<!-- $$$name --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-prop"> +<td class="tblQmlPropNode"><p> +<a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name of the test.</p> +<pre class="qml"><span class="type"><a href="qml-qdoc-test-doctest.html">DocTest</a></span> { + <span class="name">name</span>: <span class="string">"test"</span> + <span class="comment">// ...</span> +}</pre> +</div></div><!-- @@@name --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$fail[overload1]$$$fail --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="fail-method"> +<td class="tblQmlFuncNode"><p> +<a name="fail-method"></a><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>message</i>.</p> +<p>This method was introduced in QDoc.Test 1.0.</p> +</div></div><!-- @@@fail --> +<br/> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-type-members.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-type-members.html new file mode 100644 index 000000000..91cfa8643 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-type-members.html @@ -0,0 +1,31 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <title>List of All Members for Type | Test</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">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"><b><b><a href="qml-qdoc-test-type.html#fifth-prop">fifth</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#fourth-prop">fourth</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#group-prop">group</a></b></b><ul> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#group.first-prop">group.first</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#group.second-prop">group.second</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#group.third-prop">group.third</a></b></b> : int</li> +</ul> +</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#id-prop">id</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#name-prop">name</a></b></b> : string</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#type-attached-prop">type</a></b></b> : enumeration [attached]</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#completed-signal">completed</a></b></b>(<i>status</i>)</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#configured-signal">configured</a></b></b>() [attached]</li> +<li class="fn">Type <b><b><a href="qml-qdoc-test-type.html#copy-method">copy</a></b></b>(<i>a</i>)</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#disable-method">disable</a></b></b>()</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#enable-method">enable</a></b></b>()</li> +</ul> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-type.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-type.html new file mode 100644 index 000000000..166cbee81 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-type.html @@ -0,0 +1,185 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <title>Type QML Type | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></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">Type QML Type</h1> +<span class="subtitle"></span> +<!-- $$$Type-brief --> +<p>A QML type documented in a .cpp file. <a href="#details">More...</a></p> +<!-- @@@Type --> +<div class="table"><table class="alignedsummary"> +<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"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qdoc-test-type.html"><a href="testqdoc-test.html">Test</a></td></tr></table></div><ul> +<li><a href="qml-qdoc-test-type-members.html">List of all members, including inherited members</a></li> +</ul> +<a name="properties"></a> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#fifth-prop">fifth</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#fourth-prop">fourth</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#group-prop">group</a></b></b><ul> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#group.first-prop">group.first</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#group.second-prop">group.second</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#group.third-prop">group.third</a></b></b> : int</li> +</ul> +</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#id-prop">id</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#name-prop">name</a></b></b> : string</li> +</ul> +<a name="attached-properties"></a> +<h2 id="attached-properties">Attached Properties</h2> +<ul> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#type-attached-prop">type</a></b></b> : enumeration</li> +</ul> +<a name="signals"></a> +<h2 id="signals">Signals</h2> +<ul> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#completed-signal">completed</a></b></b>(<i>status</i>)</li> +</ul> +<a name="attached-signals"></a> +<h2 id="attached-signals">Attached Signals</h2> +<ul> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#configured-signal">configured</a></b></b>()</li> +</ul> +<a name="methods"></a> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn">Type <b><b><a href="qml-qdoc-test-type.html#copy-method">copy</a></b></b>(<i>a</i>)</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#disable-method">disable</a></b></b>()</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#enable-method">enable</a></b></b>()</li> +</ul> +<!-- $$$Type-description --> +<a name="details"></a> +<h2 id="details">Detailed Description</h2> +<!-- @@@Type --> +<h2>Property Documentation</h2> +<!-- $$$ --> +<div class="qmlitem"><div class="fngroup"> +<div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="fifth-prop"> +<td class="tblQmlPropNode"><p> +<a name="fifth-prop"></a><span class="name">fifth</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="fourth-prop"> +<td class="tblQmlPropNode"><p> +<a name="fourth-prop"></a><span class="name">fourth</span> : <span class="type"><a href="qml-int.html">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"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="even" id="group-prop"><th class="centerAlign"><p><a name="group-prop"></a><b>group group</b></p></th></tr> +<tr valign="top" class="odd" id="group.first-prop"> +<td class="tblQmlPropNode"><p> +<a name="group.first-prop"></a><span class="name">group.first</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="group.second-prop"> +<td class="tblQmlPropNode"><p> +<a name="group.second-prop"></a><span class="name">group.second</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="group.third-prop"> +<td class="tblQmlPropNode"><p> +<a name="group.third-prop"></a><span class="name">group.third</span> : <span class="type"><a href="qml-int.html">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"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="id-prop"> +<td class="tblQmlPropNode"><p> +<a name="id-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">id</span> : <span class="type"><a href="qml-int.html">int</a></span></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"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="name-prop"> +<td class="tblQmlPropNode"><p> +<a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></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"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="type-attached-prop"> +<td class="tblQmlPropNode"><p> +<a name="type-attached-prop"></a><span class="name">Type.type</span> : <span class="type">enumeration</span></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>Type.NoType</code></td><td class="topAlign">Nothing</td></tr> +<tr><td class="topAlign"><code>Type.SomeType</code></td><td class="topAlign">Something</td></tr> +</table></div> +</div></div><!-- @@@type --> +<br/> +<h2>Signal Documentation</h2> +<!-- $$$completed[overload1]$$$completed --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="completed-signal"> +<td class="tblQmlFuncNode"><p> +<a name="completed-signal"></a><span class="name">completed</span>(<i>status</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>This signal is emitted when the operation completed with <i>status</i>.</p> +</div></div><!-- @@@completed --> +<br/> +<h2>Attached Signal Documentation</h2> +<!-- $$$configured[overload1]$$$configured --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="configured-signal"> +<td class="tblQmlFuncNode"><p> +<a name="configured-signal"></a><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></div><!-- @@@configured --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$ --> +<div class="qmlitem"><div class="fngroup"> +<div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="disable-method"> +<td class="tblQmlFuncNode"><p> +<a name="disable-method"></a><span class="name">disable</span>()</p></td></tr> +<tr valign="top" class="odd" id="enable-method"> +<td class="tblQmlFuncNode"><p> +<a name="enable-method"></a><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"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="copy-method"> +<td class="tblQmlFuncNode"><p> +<a name="copy-method"></a><span class="type"><a href="qml-qdoc-test-type.html">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>a</i>.</p> +</div></div><!-- @@@copy --> +<br/> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/test.index b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/test.index new file mode 100644 index 000000000..f45b33114 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/test.index @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE QDOCINDEX> +<INDEX url="" title="A test project for QDoc build artifacts" version="" 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="true" meta="macrowithoutparams" virtual="non" const="false" static="false" final="false" override="false" type="" signature="QDOCTEST_MACRO"/> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="true" since="Test 1.1" meta="macrowithparams" virtual="non" const="false" static="false" final="false" override="false" type="" brief="A macro with argument x" signature="QDOCTEST_MACRO2( x)"> + <parameter type="" 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" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput/qml/parent.qdoc" lineno="29" documented="true" title="AbstractParent" fulltitle="AbstractParent" subtitle="" groups="qmltypes" brief="Abstract base QML type"> + <function name="rear" fullname="QDoc.Test.AbstractParent.rear" href="qml-qdoc-test-abstractparent.html#rear-method" status="active" access="public" location="includefromparent.qdoc" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/includefromparent.qdoc" lineno="47" documented="true" meta="qmlmethod"/> + <function name="rear" fullname="QDoc.Test.AbstractParent.rear" href="qml-qdoc-test-abstractparent.html#rear-method" status="active" access="public" location="parent.qdoc" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput/qml/parent.qdoc" lineno="42" documented="true" meta="qmlmethod"/> + <qmlproperty name="children" fullname="QDoc.Test.AbstractParent.children" status="active" access="public" location="includefromparent.qdoc" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/includefromparent.qdoc" lineno="41" documented="true" type="list<Child>" attached="false" writable="true" brief="Children of the type"/> + </qmlclass> + <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" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput/qml/parent.qdoc" lineno="47" documented="true" title="Child" fulltitle="Child" subtitle="" brief="A Child inheriting its parent"/> + <qmlclass name="DocTest" qml-module-name="QDoc.Test" fullname="QDoc.Test.DocTest" href="qml-qdoc-test-doctest.html" status="active" access="public" 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="doctest_fail" fullname="QDoc.Test.DocTest.doctest_fail" href="qml-qdoc-test-doctest.html#doctest_fail-method" status="internal" access="public" documented="true" meta="qmlmethod"/> + <function name="fail" fullname="QDoc.Test.DocTest.fail" href="qml-qdoc-test-doctest.html#fail-method" status="active" access="public" location="DocTest.qml" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput/qml/DocTest.qml" lineno="68" documented="true" since="QDoc.Test 1.0" meta="qmlmethod"/> + <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="doctest_internal" fullname="QDoc.Test.DocTest.doctest_internal" href="qml-qdoc-test-doctest.html#doctest_internal-prop" status="internal" access="public" documented="true" type="int" 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"/> + </qmlclass> + <namespace name="TestQDoc" href="testqdoc.html" status="active" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="32" 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="true" meta="macrowithoutparams" virtual="non" const="false" static="false" final="false" override="false" type="" signature="QDOCTEST_MACRO"/> + <class name="Test" fullname="TestQDoc::Test" href="testqdoc-test.html" status="active" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="34" documented="true" 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="true" since="Test 1.1" meta="macrowithparams" virtual="non" const="false" static="false" final="false" override="false" type="" brief="A macro with argument x" signature="QDOCTEST_MACRO2( x)"> + <parameter type="" name="x" default=""/> + </function> + <function name="anotherObsoleteMember" fullname="TestQDoc::Test::anotherObsoleteMember" href="testqdoc-test-obsolete.html#anotherObsoleteMember" status="obsolete" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="39" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void anotherObsoleteMember()"/> + <function name="deprecatedMember" fullname="TestQDoc::Test::deprecatedMember" href="testqdoc-test-obsolete.html#deprecatedMember" status="obsolete" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="40" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void deprecatedMember()"/> + <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="41" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"/> + <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="obsolete" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="38" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void obsoleteMember()"/> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="45" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void overload()"/> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="46" meta="plain" virtual="non" const="false" static="false" final="false" override="false" overload="true" overload-number="1" type="void" signature="void overload(bool b)"> + <parameter type="bool" name="b" default=""/> + </function> + <function name="someFunction" fullname="TestQDoc::Test::someFunction" href="testqdoc-test.html#someFunction" status="active" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="36" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="int" signature="int someFunction(int v)"> + <parameter type="int" name="v" default=""/> + </function> + <function name="someFunctionDefaultArg" fullname="TestQDoc::Test::someFunctionDefaultArg" href="testqdoc-test.html#someFunctionDefaultArg" status="active" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="37" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void someFunctionDefaultArg(int i, bool b)"> + <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" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="42" documented="true" meta="plain" virtual="virtual" const="false" static="false" final="false" override="false" type="void" signature="void virtualFun()"/> + </class> + <class name="TestDerived" fullname="TestQDoc::TestDerived" href="testqdoc-testderived.html" status="active" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="49" documented="true" bases="TestQDoc::Test" module="TestCPP" brief="A derived class in a namespace"> + <function name="virtualFun" fullname="TestQDoc::TestDerived::virtualFun" href="testqdoc-testderived.html#virtualFun" status="active" access="public" location="testcpp.h" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput\testcpp.h" lineno="51" documented="true" meta="plain" virtual="virtual" const="false" static="false" final="false" override="true" type="void" signature="void virtualFun() override"/> + </class> + </namespace> + <qmlclass name="Type" qml-module-name="QDoc.Test" fullname="QDoc.Test.Type" href="qml-qdoc-test-type.html" status="active" access="public" 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"/> + <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"/> + <function name="disable" fullname="QDoc.Test.Type.disable" href="qml-qdoc-test-type.html#disable-method" status="active" access="public" meta="qmlmethod"/> + <function name="enable" fullname="QDoc.Test.Type.enable" href="qml-qdoc-test-type.html#enable-method" status="active" access="public" meta="qmlmethod"/> + <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" 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"/> + </qmlclass> + <page name="index.html" href="index.html" status="active" location="includefromparent.qdoc" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/includefromparent.qdoc" lineno="29" documented="true" subtype="page" title="doc index" fulltitle="doc index" subtitle="" module="Test"> + <contents name="c-classes" title="C++ Classes" level="1"/> + <contents name="qml-types" title="QML Types" level="1"/> + </page> + <qmlbasictype name="int" href="qml-int.html" status="active" access="public" location="parent.qdoc" filepath="C:/qt5/qttools/tests/auto/qdoc/generatedoutput/qml/parent.qdoc" lineno="54" documented="true"/> + <group name="qmltypes" href="qmltypes.html" status="internal" seen="false" title="" members="AbstractParent"/> + <module name="TestCPP" href="testcpp-module.html" status="active" documented="true" seen="true" title="QDoc Test C++ Classes" module="Test" members="TestQDoc,Test,TestDerived" brief="A test module page"/> + <qmlmodule name="QDoc.Test" qml-module-name="QDoc.Test" qml-module-version="1.1" href="qdoc-test-qmlmodule.html" status="active" documented="true" seen="true" title="" module="Test" members="DocTest,AbstractParent,Child,int,Type" brief="QML Types for the Test module"/> + </namespace> +</INDEX> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testcpp-module.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testcpp-module.html new file mode 100644 index 000000000..b1301b5d0 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testcpp-module.html @@ -0,0 +1,42 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <title>QDoc Test C++ Classes | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></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> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">QDoc Test C++ Classes</h1> +<span class="subtitle"></span> +<!-- $$$TestCPP-brief --> +<p>A test module page. <a href="#details">More...</a></p> +<!-- @@@TestCPP --> +<a name="namespaces"></a> +<h2 id="namespaces">Namespaces</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName"><p><a href="testqdoc.html">TestQDoc</a></p></td><td class="tblDescr"><p>A namespace</p></td></tr> +</table></div> +<a name="classes"></a> +<h2 id="classes">Classes</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName"><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="even topAlign"><td class="tblName"><p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p></td><td class="tblDescr"><p>A derived class in a namespace</p></td></tr> +</table></div> +<!-- $$$TestCPP-description --> +<a name="details"></a> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@TestCPP --> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test-members.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test-members.html new file mode 100644 index 000000000..6f3ca0ff5 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test-members.html @@ -0,0 +1,22 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <title>List of All Members for Test | Test</title> +</head> +<body> +<li>Test</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">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"><span class="name"><b><a href="testqdoc-test.html#inlineFunction">inlineFunction</a></b></span>()</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#overload">overload</a></b></span>()</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#overload-1">overload</a></b></span>(bool )</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#someFunction">someFunction</a></b></span>(int ) : int</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg">someFunctionDefaultArg</a></b></span>(int , bool )</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#virtualFun">virtualFun</a></b></span>()</li> +</ul> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test-obsolete.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test-obsolete.html new file mode 100644 index 000000000..088c2ee99 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test-obsolete.html @@ -0,0 +1,36 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <title>Obsolete Members for Test | Test</title> +</head> +<body> +<li>Test</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Obsolete Members for Test</h1> +<p><b>The following members of class <a href="testqdoc-test.html">Test</a> are obsolete.</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"> +<tr><td class="memItemLeft topAlign rightAlign"> <code>(obsolete) </code>void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#anotherObsoleteMember">anotherObsoleteMember</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code>(obsolete) </code>void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#deprecatedMember">deprecatedMember</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code>(obsolete) </code>void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#obsoleteMember">obsoleteMember</a></b>()</td></tr> +</table></div> +<h2>Member Function Documentation</h2> +<!-- $$$anotherObsoleteMember[overload1]$$$anotherObsoleteMember --> +<h3 class="fn" id="anotherObsoleteMember"><a name="anotherObsoleteMember"></a><span class="type">void</span> Test::<span class="name">anotherObsoleteMember</span>()</h3> +<p>This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test-obsolete.html#obsoleteMember">obsoleteMember</a>() instead.</p> +<!-- @@@anotherObsoleteMember --> +<!-- $$$deprecatedMember[overload1]$$$deprecatedMember --> +<h3 class="fn" id="deprecatedMember"><a name="deprecatedMember"></a><span class="type">void</span> Test::<span class="name">deprecatedMember</span>()</h3> +<p>This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test.html#someFunction">someFunction</a>() instead.</p> +<!-- @@@deprecatedMember --> +<!-- $$$obsoleteMember[overload1]$$$obsoleteMember --> +<h3 class="fn" id="obsoleteMember"><a name="obsoleteMember"></a><span class="type">void</span> Test::<span class="name">obsoleteMember</span>()</h3> +<p>This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test.html#someFunction">someFunction</a>() instead.</p> +<!-- @@@obsoleteMember --> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test.html new file mode 100644 index 000000000..53db06685 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-test.html @@ -0,0 +1,91 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <title>Test Class | Test</title> +</head> +<body> +<li>Test</li> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></h3> +<ul> +<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="#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">Test Class</h1> +<span class="small-subtitle">(<a href="testqdoc-test.html">TestQDoc::Test</a>)<br/></span> +<!-- $$$Test-brief --> +<p>A class in a namespace. <a href="#details">More...</a></p> +<!-- @@@Test --> +<div class="table"><table class="alignedsummary"> +<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"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qdoc-test-type.html">Type</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="testqdoc-testderived.html">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">Obsolete members</a></li> +</ul> +<a name="public-functions"></a> +<h2 id="public-functions">Public Functions</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#inlineFunction">inlineFunction</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunction">someFunction</a></b>(int <i>v</i>)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunctionDefaultArg">someFunctionDefaultArg</a></b>(int <i>i</i>, bool <i>b</i> = false)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#virtualFun">virtualFun</a></b>()</td></tr> +</table></div> +<a name="protected-functions"></a> +<h2 id="protected-functions">Protected Functions</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload">overload</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1">overload</a></b>(bool <i>b</i>)</td></tr> +</table></div> +<a name="macros"></a> +<h2 id="macros">Macros</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#QDOCTEST_MACRO2">QDOCTEST_MACRO2</a></b>(<i>x</i>)</td></tr> +</table></div> +<a name="details"></a> +<!-- $$$Test-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@Test --> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$ --> +<div class="fngroup"> +<h3 class="fn fngroupitem" id="overload"><a name="overload"></a><code>[protected] </code><span class="type">void</span> Test::<span class="name">overload</span>()</h3><h3 class="fn fngroupitem" id="overload-1"><a name="overload-1"></a><code>[protected] </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>b</i>.</p> +<!-- @@@ --> +<!-- $$$inlineFunction[overload1]$$$inlineFunction --> +<h3 class="fn" id="inlineFunction"><a name="inlineFunction"></a><span class="type">void</span> Test::<span class="name">inlineFunction</span>()</h3> +<p>An inline function, documented using the \fn QDoc command.</p> +<!-- @@@inlineFunction --> +<!-- $$$someFunction[overload1]$$$someFunctionint --> +<h3 class="fn" id="someFunction"><a name="someFunction"></a><span class="type">int</span> Test::<span class="name">someFunction</span>(<span class="type">int</span> <i>v</i>)</h3> +<p>Function that takes a parameter <i>v</i>. Also returns the value of <i>v</i>.</p> +<!-- @@@someFunction --> +<!-- $$$someFunctionDefaultArg[overload1]$$$someFunctionDefaultArgintbool --> +<h3 class="fn" id="someFunctionDefaultArg"><a name="someFunctionDefaultArg"></a><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)</h3> +<p>Function that takes a parameter <i>i</i> and <i>b</i>.</p> +<!-- @@@someFunctionDefaultArg --> +<!-- $$$virtualFun[overload1]$$$virtualFun --> +<h3 class="fn" id="virtualFun"><a name="virtualFun"></a><code>[virtual] </code><span class="type">void</span> Test::<span class="name">virtualFun</span>()</h3> +<p>Function that must be reimplemented.</p> +<!-- @@@virtualFun --> +</div> +<div class="macros"> +<h2>Macro Documentation</h2> +<!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2 --> +<h3 class="fn" id="QDOCTEST_MACRO2"><a name="QDOCTEST_MACRO2"></a><span class="name">QDOCTEST_MACRO2</span>(<i>x</i>)</h3> +<p>A macro with argument <i>x</i>.</p> +<p>This function was introduced in Test 1.1.</p> +<!-- @@@QDOCTEST_MACRO2 --> +</div> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-testderived-members.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-testderived-members.html new file mode 100644 index 000000000..0babbbd5f --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-testderived-members.html @@ -0,0 +1,22 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <title>List of All Members for TestDerived | Test</title> +</head> +<body> +<li>TestDerived</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">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> +<ul> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#inlineFunction">inlineFunction</a></b></span>()</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#overload">overload</a></b></span>()</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#overload-1">overload</a></b></span>(bool )</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#someFunction">someFunction</a></b></span>(int ) : int</li> +<li class="fn"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg">someFunctionDefaultArg</a></b></span>(int , bool )</li> +<li class="fn"><span class="name"><b><a href="testqdoc-testderived.html#virtualFun">virtualFun</a></b></span>()</li> +</ul> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-testderived.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-testderived.html new file mode 100644 index 000000000..8f7517cd3 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc-testderived.html @@ -0,0 +1,48 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <title>TestDerived Class | Test</title> +</head> +<body> +<li>TestDerived</li> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></h3> +<ul> +<li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public 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">TestDerived Class</h1> +<span class="small-subtitle">(<a href="testqdoc-testderived.html">TestQDoc::TestDerived</a>)<br/></span> +<!-- $$$TestDerived-brief --> +<p>A derived class in a namespace. <a href="#details">More...</a></p> +<!-- @@@TestDerived --> +<div class="table"><table class="alignedsummary"> +<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"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-test.html">TestQDoc::Test</a></td></tr></table></div><ul> +<li><a href="testqdoc-testderived-members.html">List of all members, including inherited members</a></li> +</ul> +<a name="reimplemented-public-functions"></a> +<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#virtualFun">virtualFun</a></b>() override</td></tr> +</table></div> +<a name="details"></a> +<!-- $$$TestDerived-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@TestDerived --> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$virtualFun[overload1]$$$virtualFun --> +<h3 class="fn" id="virtualFun"><a name="virtualFun"></a><code>[override virtual] </code><span class="type">void</span> TestDerived::<span class="name">virtualFun</span>()</h3> +<p>Reimplements: <a href="testqdoc-test.html#virtualFun">Test::virtualFun</a>().</p> +<!-- @@@virtualFun --> +</div> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc.html b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc.html new file mode 100644 index 000000000..9c6f5b6ae --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/includefromexampledirs/testqdoc.html @@ -0,0 +1,64 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <title>TestQDoc Namespace | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3><a name="toc">Contents</a></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">TestQDoc Namespace</h1> +<!-- $$$TestQDoc-brief --> +<p>A namespace. <a href="#details">More...</a></p> +<!-- @@@TestQDoc --> +<div class="table"><table class="alignedsummary"> +<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"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr></table></div><ul> +</ul> +<a name="classes"></a> +<h2 id="classes">Classes</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html">Test</a></b></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html">TestDerived</a></b></td></tr> +</table></div> +<a name="macros"></a> +<h2 id="macros">Macros</h2> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc.html#QDOCTEST_MACRO">QDOCTEST_MACRO</a></b></td></tr> +</table></div> +<a name="details"></a> +<!-- $$$TestQDoc-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<a name="usage"></a> +<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 derived class in a namespace. <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" id="QDOCTEST_MACRO"><a name="QDOCTEST_MACRO"></a><span class="name">QDOCTEST_MACRO</span></h3> +<!-- @@@QDOCTEST_MACRO --> +</div> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-abstractparent.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-abstractparent.html index 949dc7868..3668112ee 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-abstractparent.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-abstractparent.html @@ -46,7 +46,7 @@ <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="children-prop"> <td class="tblQmlPropNode"><p> -<span class="qmldefault">[default] </span><span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html">Child</a></span>></p></td></tr> +<a name="children-prop"></a><span class="qmldefault">[default] </span><span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html">Child</a></span>></p></td></tr> </table></div></div> <div class="qmldoc"><p>Children of the type.</p> </div></div><!-- @@@children --> @@ -57,7 +57,7 @@ <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>(<i>child</i>)</p></td></tr> +<a name="rear-method"></a><span class="type">void</span> <span class="name">rear</span>(<i>child</i>)</p></td></tr> </table></div></div> <div class="qmldoc"><p>Do some abstract parenting on <i>child</i>.</p> </div></div><!-- @@@rear --> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-child.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-child.html index 5ba40c99c..22f38cc9c 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-child.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-child.html @@ -46,7 +46,7 @@ <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="children-prop"> <td class="tblQmlPropNode"><p> -<span class="qmldefault">[default] </span><span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html">Child</a></span>></p></td></tr> +<a name="children-prop"></a><span class="qmldefault">[default] </span><span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html">Child</a></span>></p></td></tr> </table></div></div> <div class="qmldoc"><p>Children of the type.</p> </div></div><!-- @@@children --> @@ -57,7 +57,7 @@ <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>(<i>child</i>)</p></td></tr> +<a name="rear-method"></a><span class="type">void</span> <span class="name">rear</span>(<i>child</i>)</p></td></tr> </table></div></div> <div class="qmldoc"><p>Do some abstract parenting on <i>child</i>.</p> </div></div><!-- @@@rear --> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-doctest.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-doctest.html index a88d935be..e1475d5fb 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-doctest.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-doctest.html @@ -50,7 +50,7 @@ <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></p></td></tr> +<a name="active-prop"></a><span class="name">active</span> : <span class="type">bool</span></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">name</a>.</p> @@ -61,7 +61,7 @@ <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> +<a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr> </table></div></div> <div class="qmldoc"><p>Name of the test.</p> <pre class="qml"><span class="type"><a href="qml-qdoc-test-doctest.html">DocTest</a></span> { @@ -76,7 +76,7 @@ <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="fail-method"> <td class="tblQmlFuncNode"><p> -<span class="name">fail</span>(<i>message</i> = "oops")</p></td></tr> +<a name="fail-method"></a><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>message</i>.</p> <p>This method was introduced in QDoc.Test 1.0.</p> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html index 363a4bf16..166cbee81 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html @@ -75,10 +75,10 @@ <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">int</a></span></p></td></tr> +<a name="fifth-prop"></a><span class="name">fifth</span> : <span class="type"><a href="qml-int.html">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">int</a></span></p></td></tr> +<a name="fourth-prop"></a><span class="name">fourth</span> : <span class="type"><a href="qml-int.html">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><!-- @@@ --> @@ -86,16 +86,16 @@ <!-- $$$group --> <div class="qmlitem"><div class="qmlproto"> <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="even" id="group-prop"><th class="centerAlign"><p><a name="group-prop"></a><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">int</a></span></p></td></tr> +<a name="group.first-prop"></a><span class="name">group.first</span> : <span class="type"><a href="qml-int.html">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">int</a></span></p></td></tr> +<a name="group.second-prop"></a><span class="name">group.second</span> : <span class="type"><a href="qml-int.html">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">int</a></span></p></td></tr> +<a name="group.third-prop"></a><span class="name">group.third</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> </table></div></div> <div class="qmldoc"><p>A property group.</p> </div></div><!-- @@@group --> @@ -105,7 +105,7 @@ <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="id-prop"> <td class="tblQmlPropNode"><p> -<span class="qmlreadonly">[read-only] </span><span class="name">id</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +<a name="id-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">id</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> </table></div></div> <div class="qmldoc"><p>A read-only property.</p> </div></div><!-- @@@id --> @@ -115,7 +115,7 @@ <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> +<a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr> </table></div></div> <div class="qmldoc"><p>Name of the Test.</p> </div></div><!-- @@@name --> @@ -126,7 +126,7 @@ <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></p></td></tr> +<a name="type-attached-prop"></a><span class="name">Type.type</span> : <span class="type">enumeration</span></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>Type.NoType</code></td><td class="topAlign">Nothing</td></tr> @@ -140,7 +140,7 @@ <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="completed-signal"> <td class="tblQmlFuncNode"><p> -<span class="name">completed</span>(<i>status</i>)</p></td></tr> +<a name="completed-signal"></a><span class="name">completed</span>(<i>status</i>)</p></td></tr> </table></div></div> <div class="qmldoc"><p>This signal is emitted when the operation completed with <i>status</i>.</p> </div></div><!-- @@@completed --> @@ -151,7 +151,7 @@ <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> +<a name="configured-signal"></a><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></div><!-- @@@configured --> @@ -163,10 +163,10 @@ <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> +<a name="disable-method"></a><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> +<a name="enable-method"></a><span class="name">enable</span>()</p></td></tr> </table></div></div> </div><div class="qmldoc"><p>Enables or disables this type.</p> </div></div><!-- @@@ --> @@ -176,7 +176,7 @@ <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">Type</a></span> <span class="name">copy</span>(<i>a</i>)</p></td></tr> +<a name="copy-method"></a><span class="type"><a href="qml-qdoc-test-type.html">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>a</i>.</p> </div></div><!-- @@@copy --> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-progressbar.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-progressbar.html index 6cfe36a83..a1b43ea9d 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-progressbar.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-progressbar.html @@ -46,7 +46,7 @@ <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> +<a name="color-prop"></a><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">ProgressBar</a>'s gradient. Must bind to a color type.</p> <p><b>See also </b><a href="qml-uicomponents-progressbar.html#secondColor-prop">secondColor</a>.</p> @@ -57,7 +57,7 @@ <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">int</a></span></p></td></tr> +<a name="maximum-prop"></a><span class="name">maximum</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> </table></div></div> <div class="qmldoc"><p>The maximum value of the <a href="qml-uicomponents-progressbar.html">ProgressBar</a> range. The <a href="qml-uicomponents-progressbar.html#value-prop">value</a> must not be more than this value.</p> </div></div><!-- @@@maximum --> @@ -67,7 +67,7 @@ <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">int</a></span></p></td></tr> +<a name="minimum-prop"></a><span class="name">minimum</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> </table></div></div> <div class="qmldoc"><p>The minimum value of the <a href="qml-uicomponents-progressbar.html">ProgressBar</a> range. The <a href="qml-uicomponents-progressbar.html#value-prop">value</a> must not be less than this value.</p> </div></div><!-- @@@minimum --> @@ -77,7 +77,7 @@ <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> +<a name="secondColor-prop"></a><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">ProgressBar</a>'s gradient. Must bind to a color type.</p> <p><b>See also </b><a href="qml-uicomponents-progressbar.html#color-prop">color</a>.</p> @@ -88,7 +88,7 @@ <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">int</a></span></p></td></tr> +<a name="value-prop"></a><span class="name">value</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> </table></div></div> <div class="qmldoc"><p>The value of the progress.</p> </div></div><!-- @@@value --> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html index 5ebae4905..fadb1a531 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html @@ -48,7 +48,7 @@ <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> +<a name="on-prop"></a><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>false</code>, then the switch is in the <code>off</code> state.</p> </div></div><!-- @@@on --> @@ -59,7 +59,7 @@ <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> +<a name="toggle-method"></a><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>on</code>, the toggling it will turn it <code>off</code>. Toggling a switch in the <code>off</code> position will turn it <code>on</code>.</p> </div></div><!-- @@@toggle --> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-tabwidget.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-tabwidget.html index 2c48e1ddd..1b2421722 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-tabwidget.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-tabwidget.html @@ -62,7 +62,7 @@ <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">int</a></span></p></td></tr> +<a name="current-prop"></a><span class="name">current</span> : <span class="type"><a href="qml-int.html">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">TabWidget</a>.</p> </div></div><!-- @@@current --> @@ -72,7 +72,7 @@ <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="sampleReadOnlyProperty-prop"> <td class="tblQmlPropNode"><p> -<span class="qmlreadonly">[read-only] </span><span class="name">sampleReadOnlyProperty</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +<a name="sampleReadOnlyProperty-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">sampleReadOnlyProperty</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> </table></div></div> <div class="qmldoc"><p>A sample <code>read-only</code> property. A contrived property to demonstrate QDoc's ability to detect read-only properties.</p> <p>The signature is:</p> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/test-componentset-example.html b/tests/auto/qdoc/generatedoutput/expected_output/test-componentset-example.html index faf632bea..8b792090f 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/test-componentset-example.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/test-componentset-example.html @@ -19,6 +19,9 @@ <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QML Documentation Example</h1> <span class="subtitle"></span> +<!-- $$$componentset-brief --> +<p>Example for documenting QML types.</p> +<!-- @@@componentset --> <!-- $$$componentset-description --> <div class="descr"> <a name="details"></a> <p>This example demonstrates one of the ways to document QML types.</p> @@ -42,6 +45,13 @@ An aliased property of type <span class="type">int</span><span class="operator"> <a name="qml-types-with-c-implementation"></a> <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">componentset/ProgressBar.qml</a></li> +<li><a href="test-componentset-switch-qml.html">componentset/Switch.qml</a></li> +<li><a href="test-componentset-tabwidget-qml.html">componentset/TabWidget.qml</a></li> +<li><a href="test-componentset-componentset-pro.html">componentset/componentset.pro</a></li> +</ul> </div> <!-- @@@componentset --> </body> diff --git a/tests/auto/qdoc/generatedoutput/includefromexampledirs/excludes/anotherindex.qdoc b/tests/auto/qdoc/generatedoutput/includefromexampledirs/excludes/anotherindex.qdoc new file mode 100644 index 000000000..75dd9197d --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/includefromexampledirs/excludes/anotherindex.qdoc @@ -0,0 +1,39 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:GPL-EXCEPT$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 as published by the Free Software +** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +//! exampledirs-include + \page index.html + \title doc index + + \section1 C++ Classes + \generatelist {classesbymodule TestCPP} + \section1 QML Types + \annotatedlist qmltypes +//! exampledirs-include +*/ diff --git a/tests/auto/qdoc/generatedoutput/includefromexampledirs/excludes/parentinclude.qdoc b/tests/auto/qdoc/generatedoutput/includefromexampledirs/excludes/parentinclude.qdoc new file mode 100644 index 000000000..c95e22125 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/includefromexampledirs/excludes/parentinclude.qdoc @@ -0,0 +1,64 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:GPL-EXCEPT$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 as published by the Free Software +** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +//! abstract-type + \qmltype AbstractParent + \ingroup qmltypes + \qmlabstract + \brief Abstract base QML type. +//! abstract-type +*/ + +/*! +//! children-qmlproperty + \qmlproperty list<Child> AbstractParent::children + \default + \brief Children of the type. +//! children-qmlproperty +*/ + +/*! +//! rear-qmlmethod + \qmlmethod void AbstractParent::rear(Child child) + \brief Do some abstract parenting on \a child. +//! rear-qmlmethod +*/ + +/*! + \qmltype Child + \ingroup qmltypes + \inherits AbstractParent + \brief A Child inheriting its parent. +*/ + +/*! + \qmlbasictype int + \ingroup qmltypes + \brief An integer basic type. +*/ diff --git a/tests/auto/qdoc/generatedoutput/includefromexampledirs/includefromexampledirs.qdocconf b/tests/auto/qdoc/generatedoutput/includefromexampledirs/includefromexampledirs.qdocconf new file mode 100644 index 000000000..05683c80b --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/includefromexampledirs/includefromexampledirs.qdocconf @@ -0,0 +1,12 @@ +include(../testqml.qdocconf) + +includepaths += .. +sourcedirs += src + +excludedirs += excludes \ + ../qml/componentset + +exampledirs += excludes + +HTML.nosubdirs = true +HTML.outputsubdir = includefromexampledirs diff --git a/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/includefromparent.qdoc b/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/includefromparent.qdoc new file mode 100644 index 000000000..7b4c00b76 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/includefromparent.qdoc @@ -0,0 +1,51 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:GPL-EXCEPT$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 as published by the Free Software +** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\include anotherindex.qdoc exampledirs-include + +\include parent.qdocinc +*/ + +/*! +\include parentinclude.qdoc abstract-type + +\include parent.qdocinc +*/ + +/*! +\include parentinclude.qdoc children-qmlproperty + +\include parent.qdocinc +*/ + +/*! +\include parentinclude.qdoc rear-qmlmethod + +\include parent.qdocinc +*/ diff --git a/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/parent.qdocinc b/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/parent.qdocinc new file mode 100644 index 000000000..307c39dbd --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/includefromexampledirs/src/parent.qdocinc @@ -0,0 +1 @@ +Test include file that is part of the sourcedirs. diff --git a/tests/auto/qdoc/generatedoutput/qml/componentset/examples.qdoc b/tests/auto/qdoc/generatedoutput/qml/componentset/examples.qdoc index 7c780eca8..2f56c221c 100644 --- a/tests/auto/qdoc/generatedoutput/qml/componentset/examples.qdoc +++ b/tests/auto/qdoc/generatedoutput/qml/componentset/examples.qdoc @@ -28,6 +28,10 @@ /*! \example componentset \title QML Documentation Example + \brief Example for documenting QML types. + + \meta tag {test,sample} + \meta installpath tutorials This example demonstrates one of the ways to document QML types. diff --git a/tests/auto/qdoc/generatedoutput/testqml.qdocconf b/tests/auto/qdoc/generatedoutput/testqml.qdocconf index c469bde06..f618fe1b8 100644 --- a/tests/auto/qdoc/generatedoutput/testqml.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testqml.qdocconf @@ -16,5 +16,7 @@ excludedirs = ./bug80259 sources.fileextensions = "*.qml *.cpp *.qdoc" headers.fileextensions = "*.h" +examples.fileextensions = "*.qml" + macro.begincomment = "\\c{/*}" macro.QDocTestVer = "1.1" diff --git a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp index f1c0b892e..4cab6a8fd 100644 --- a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp +++ b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp @@ -63,6 +63,7 @@ private slots: void dontDocument(); void inheritedQmlPropertyGroups(); void crossModuleLinking(); + void includeFromExampleDirs(); private: QScopedPointer<QTemporaryDir> m_outputDir; @@ -334,6 +335,14 @@ void tst_generatedOutput::crossModuleLinking() indexDir.toLatin1().data()); } +void tst_generatedOutput::includeFromExampleDirs() +{ + testAndCompare("includefromexampledirs/includefromexampledirs.qdocconf", + "includefromexampledirs/index.html " + "includefromexampledirs/qml-qdoc-test-abstractparent.html " + "includefromexampledirs/qml-qdoc-test-abstractparent-members.html"); +} + QTEST_APPLESS_MAIN(tst_generatedOutput) #include "tst_generatedoutput.moc" |