diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-12-04 12:55:12 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-12-06 12:14:16 +0100 |
| commit | 54179a445a9c968c4c56c20336fe5b2d732cdae0 (patch) | |
| tree | 006a6e55793afbff9bcddd3b527f0c573efdc803 | |
| parent | ba7da547208222ad023f13d4f95ba596689148f0 (diff) | |
| download | qttools-54179a445a9c968c4c56c20336fe5b2d732cdae0.tar.gz | |
Improve QDoc autotest for QML documentation
Fix the previous test that never generated any QML type documentation,
and add new test types, documented in .cpp, .qdoc, and inline in .qml.
Use all available \qml-specific QDoc commands.
Fixes: QTBUG-80154
Change-Id: I60d9762836b986ca534c664517274517b73c085d
Reviewed-by: Levon Sargsyan <levon.sargsyan@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
22 files changed, 945 insertions, 5 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qdoc-test-qmlmodule.html b/tests/auto/qdoc/generatedoutput/expected_output/qdoc-test-qmlmodule.html new file mode 100644 index 000000000..0d424fb73 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qdoc-test-qmlmodule.html @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; 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/qml-int.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-int.html new file mode 100644 index 000000000..108bf6a37 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-int.html @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; 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/qml-qdoc-test-abstractparent.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-abstractparent.html new file mode 100644 index 000000000..5b9bad572 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-abstractparent.html @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; 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">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=""> +<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> +</div></div><!-- @@@children --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$rear[overload1]$$$rear --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<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> +</div></div><!-- @@@rear --> +<br/> +</body> +</html> 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 new file mode 100644 index 000000000..c9cb241af --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-child.html @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; 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">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=""> +<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> +</div></div><!-- @@@children --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$rear[overload1]$$$rear --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<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> +</div></div><!-- @@@rear --> +<br/> +</body> +</html> 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 new file mode 100644 index 000000000..8ad2b4d5e --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-doctest.html @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; 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=""> +<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=""> +<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=""> +<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/qml-qdoc-test-type-members.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type-members.html new file mode 100644 index 000000000..a227cfc0a --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type-members.html @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; 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#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> +</ul> +</body> +</html> 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 new file mode 100644 index 000000000..8bd343fa1 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html @@ -0,0 +1,141 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; 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#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> +</ul> +<!-- $$$Type-description --> +<a name="details"></a> +<h2 id="details">Detailed Description</h2> +<!-- @@@Type --> +<h2>Property Documentation</h2> +<!-- $$$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=""> +<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=""> +<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=""> +<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=""> +<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=""> +<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> +<!-- $$$copy[overload1]$$$copy --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<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/qml-uicomponents-progressbar.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-progressbar.html new file mode 100644 index 000000000..5a25e2ff1 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-progressbar.html @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<!-- ProgressBar.qml --> + <title>ProgressBar 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="#details">Detailed Description</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">ProgressBar QML Type</h1> +<span class="subtitle"></span> +<!-- $$$ProgressBar-brief --> +<p>A component that shows the progress of an event. <a href="#details">More...</a></p> +<!-- @@@ProgressBar --> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import UIComponents 1.0</td></tr></table></div><ul> +<li><a href="qml-uicomponents-progressbar-members.html">List of all members, including inherited members</a></li> +</ul> +<a name="properties"></a> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn"><b><b><a href="qml-uicomponents-progressbar.html#color-prop">color</a></b></b> : color</li> +<li class="fn"><b><b><a href="qml-uicomponents-progressbar.html#maximum-prop">maximum</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-uicomponents-progressbar.html#minimum-prop">minimum</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-uicomponents-progressbar.html#secondColor-prop">secondColor</a></b></b> : color</li> +<li class="fn"><b><b><a href="qml-uicomponents-progressbar.html#value-prop">value</a></b></b> : int</li> +</ul> +<!-- $$$ProgressBar-description --> +<a name="details"></a> +<h2 id="details">Detailed Description</h2> +<p>A ProgressBar shows the linear progress of an event as its <a href="qml-uicomponents-progressbar.html#value-prop">value</a>. The range is specified using the <a href="qml-uicomponents-progressbar.html#minimum-prop">minimum</a> and the <a href="qml-uicomponents-progressbar.html#maximum-prop">maximum</a> values.</p> +<p>The ProgressBar component is part of the <a href="uicomponents-qmlmodule.html">UI Components</a> module.</p> +<p>This documentation is part of the <a href="test-componentset-example.html">UIComponents</a> example.</p> +<!-- @@@ProgressBar --> +<h2>Property Documentation</h2> +<!-- $$$color --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlPropNode"><p> +<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> +</div></div><!-- @@@color --> +<br/> +<!-- $$$maximum --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlPropNode"><p> +<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 --> +<br/> +<!-- $$$minimum --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlPropNode"><p> +<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 --> +<br/> +<!-- $$$secondColor --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlPropNode"><p> +<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> +</div></div><!-- @@@secondColor --> +<br/> +<!-- $$$value --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlPropNode"><p> +<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 --> +<br/> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html new file mode 100644 index 000000000..06d7ab184 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<!-- Switch.qml --> + <title>Switch 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">Switch QML Type</h1> +<span class="subtitle"></span> +<!-- $$$Switch-brief --> +<p>A component that can be turned on or off. <a href="#details">More...</a></p> +<!-- @@@Switch --> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import UIComponents 1.0</td></tr></table></div><ul> +<li><a href="qml-uicomponents-switch-members.html">List of all members, including inherited members</a></li> +</ul> +<a name="properties"></a> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn"><b><b><a href="qml-uicomponents-switch.html#on-prop">on</a></b></b> : bool</li> +</ul> +<a name="methods"></a> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn"><b><b><a href="qml-uicomponents-switch.html#toggle-method">toggle</a></b></b>()</li> +</ul> +<!-- $$$Switch-description --> +<a name="details"></a> +<h2 id="details">Detailed Description</h2> +<p>A toggle switch has two states: an <code>on</code> and an <code>off</code> state. The <code>off</code> state is when the <a href="qml-uicomponents-switch.html#on-prop">on</a> property is set to <code>false</code>.</p> +<p>The ToggleSwitch component is part of the <a href="uicomponents-qmlmodule.html">UI Components</a> module.</p> +<p>This documentation is part of the <a href="test-componentset-example.html">UIComponents</a> example.</p> +<!-- @@@Switch --> +<h2>Property Documentation</h2> +<!-- $$$on --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlPropNode"><p> +<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 --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$toggle[overload1]$$$toggle --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlFuncNode"><p> +<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 --> +<br/> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-tabwidget.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-tabwidget.html new file mode 100644 index 000000000..991737785 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-tabwidget.html @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html> +<html lang="en"> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<!-- TabWidget.qml --> + <title>TabWidget 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="#details">Detailed Description</a></li> +<li class="level2"><a href="#adding-tabs">Adding Tabs</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">TabWidget QML Type</h1> +<span class="subtitle"></span> +<!-- $$$TabWidget-brief --> +<p>A widget that places its children as tabs. <a href="#details">More...</a></p> +<!-- @@@TabWidget --> +<div class="table"><table class="alignedsummary"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import UIComponents 1.0</td></tr></table></div><ul> +<li><a href="qml-uicomponents-tabwidget-members.html">List of all members, including inherited members</a></li> +</ul> +<a name="properties"></a> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn"><b><b><a href="qml-uicomponents-tabwidget.html#current-prop">current</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-uicomponents-tabwidget.html#sampleReadOnlyProperty-prop">sampleReadOnlyProperty</a></b></b> : int</li> +</ul> +<!-- $$$TabWidget-description --> +<a name="details"></a> +<h2 id="details">Detailed Description</h2> +<p>A TabWidget places its children as tabs in a view. Selecting a tab involves selecting the tab at the top.</p> +<p>The TabWidget component is part of the <a href="uicomponents-qmlmodule.html">UI Components</a> module.</p> +<p>This documentation is part of the <a href="test-componentset-example.html">UIComponents</a> example.</p> +<a name="adding-tabs"></a> +<h2 id="adding-tabs">Adding Tabs</h2> +<p>To add a tab, declare the tab as a child of the TabWidget.</p> +<pre class="cpp">TabWidget { + id: tabwidget + + Rectangle { + id: tab1 + color: <span class="string">"red"</span> + <span class="comment">//... omitted</span> + } + Rectangle { + id: tab2 + color: <span class="string">"blue"</span> + <span class="comment">//... omitted</span> + } + +}</pre> +<!-- @@@TabWidget --> +<h2>Property Documentation</h2> +<!-- $$$current --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlPropNode"><p> +<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 --> +<br/> +<!-- $$$sampleReadOnlyProperty --> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id=""> +<td class="tblQmlPropNode"><p> +<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> +<pre class="cpp">readonly property <span class="type"><a href="qml-int.html">int</a></span> sampleReadOnlyProperty: <span class="number">0</span></pre> +<p>Note that the property must be initialized to a value.</p> +</div></div><!-- @@@sampleReadOnlyProperty --> +<br/> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/uicomponents-qmlmodule.html b/tests/auto/qdoc/generatedoutput/expected_output/uicomponents-qmlmodule.html index 8c577ab7f..5aa475abc 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/uicomponents-qmlmodule.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/uicomponents-qmlmodule.html @@ -16,5 +16,10 @@ <p>This module is part of the <a href="test-componentset-example.html">UIComponents</a> example.</p> </div> <!-- @@@UIComponents --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName"><p><a href="qml-uicomponents-progressbar.html">ProgressBar</a></p></td><td class="tblDescr"><p>A component that shows the progress of an event</p></td></tr> +<tr class="even topAlign"><td class="tblName"><p><a href="qml-uicomponents-switch.html">Switch</a></p></td><td class="tblDescr"><p>A component that can be turned on or off</p></td></tr> +<tr class="odd topAlign"><td class="tblName"><p><a href="qml-uicomponents-tabwidget.html">TabWidget</a></p></td><td class="tblDescr"><p>A widget that places its children as tabs</p></td></tr> +</table></div> </body> </html> diff --git a/tests/auto/qdoc/generatedoutput/qml/DocTest.qml b/tests/auto/qdoc/generatedoutput/qml/DocTest.qml new file mode 100644 index 000000000..1ddafcfe4 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/qml/DocTest.qml @@ -0,0 +1,84 @@ +/**************************************************************************** +** +** Copyright (C) 2019 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$ +** +****************************************************************************/ + +import QtQuick 2.0 + +/*! + \qmltype DocTest + \inherits Test + \inqmlmodule QDoc.Test + \brief Represents a doc test case. + \since QDoc.Test 0.9 + + \section1 Introduction + + A documentation test case, itself documented inline in DocTest.qml. +*/ +Item { + id: testCase + + /*! + \qmlproperty string DocTest::name + + Name of the test. + \qml + DocTest { + name: "test" + // ... + } + \endqml + */ + property string name + + /*! + Whether the test is active. + + \sa name + */ + property bool active: true + + /*! \internal */ + property int doctest_internal: -1 + + /*! + \qmlmethod DocTest::fail(message = "oops") + \since QDoc.Test 1.0 + + Fails the current test case, with the optional \a message. + */ + function fail(msg) { + if (msg === undefined) + msg = "oops"; + } + + /*! \internal */ + function doctest_fail(msg) { + if (msg === undefined) + msg = ""; + } +} diff --git a/tests/auto/qdoc/generatedoutput/componentset/ProgressBar.qml b/tests/auto/qdoc/generatedoutput/qml/componentset/ProgressBar.qml index 2a40cc488..2a40cc488 100644 --- a/tests/auto/qdoc/generatedoutput/componentset/ProgressBar.qml +++ b/tests/auto/qdoc/generatedoutput/qml/componentset/ProgressBar.qml diff --git a/tests/auto/qdoc/generatedoutput/componentset/Switch.qml b/tests/auto/qdoc/generatedoutput/qml/componentset/Switch.qml index db9616b69..db9616b69 100644 --- a/tests/auto/qdoc/generatedoutput/componentset/Switch.qml +++ b/tests/auto/qdoc/generatedoutput/qml/componentset/Switch.qml diff --git a/tests/auto/qdoc/generatedoutput/componentset/TabWidget.qml b/tests/auto/qdoc/generatedoutput/qml/componentset/TabWidget.qml index 07fd40db9..07fd40db9 100644 --- a/tests/auto/qdoc/generatedoutput/componentset/TabWidget.qml +++ b/tests/auto/qdoc/generatedoutput/qml/componentset/TabWidget.qml diff --git a/tests/auto/qdoc/generatedoutput/componentset/componentset.pro b/tests/auto/qdoc/generatedoutput/qml/componentset/componentset.pro index 5b44737c2..5b44737c2 100644 --- a/tests/auto/qdoc/generatedoutput/componentset/componentset.pro +++ b/tests/auto/qdoc/generatedoutput/qml/componentset/componentset.pro diff --git a/tests/auto/qdoc/generatedoutput/examples.qdoc b/tests/auto/qdoc/generatedoutput/qml/componentset/examples.qdoc index 7c780eca8..7c780eca8 100644 --- a/tests/auto/qdoc/generatedoutput/examples.qdoc +++ b/tests/auto/qdoc/generatedoutput/qml/componentset/examples.qdoc diff --git a/tests/auto/qdoc/generatedoutput/componentset/uicomponents.qdoc.sample b/tests/auto/qdoc/generatedoutput/qml/componentset/uicomponents.qdoc.sample index 0c6d187ed..0c6d187ed 100644 --- a/tests/auto/qdoc/generatedoutput/componentset/uicomponents.qdoc.sample +++ b/tests/auto/qdoc/generatedoutput/qml/componentset/uicomponents.qdoc.sample diff --git a/tests/auto/qdoc/generatedoutput/qml/parent.qdoc b/tests/auto/qdoc/generatedoutput/qml/parent.qdoc new file mode 100644 index 000000000..e0bed66c0 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/qml/parent.qdoc @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2019 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$ +** +****************************************************************************/ + +/*! + \qmltype AbstractParent + \inqmlmodule QDoc.Test + \qmlabstract + \brief Abstract base QML type. +*/ + +/*! + \qmlproperty list<Child> AbstractParent::children + \default + \brief Children of the type. +*/ + +/*! + \qmlmethod void AbstractParent::rear(Child child) + \brief Do some abstract parenting on \a child. +*/ + +/*! + \qmltype Child + \inqmlmodule QDoc.Test + \inherits AbstractParent + \brief A Child inheriting its parent. +*/ + +/*! + \qmlbasictype int + \inqmlmodule QDoc.Test + + \brief An integer basic type. +*/ diff --git a/tests/auto/qdoc/generatedoutput/qml/type.cpp b/tests/auto/qdoc/generatedoutput/qml/type.cpp new file mode 100644 index 000000000..db3dd1047 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/qml/type.cpp @@ -0,0 +1,87 @@ +/**************************************************************************** +** +** Copyright (C) 2019 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 "testcpp.h" + +/*! + \qmlmodule QDoc.Test \QDocTestVer + \brief QML Types for the Test module. +*/ + +/*! + \qmltype Type + \instantiates TestQDoc::Test + \inqmlmodule QDoc.Test + \brief A QML type documented in a .cpp file. +*/ + +/*! + \qmlproperty int Type::id + \readonly + \brief A read-only property. +*/ + +/*! + \qmlproperty string QDoc.Test::Type::name + \brief Name of the Test. +*/ + +/*! + \qmlattachedproperty enumeration Type::type + + \value Type.NoType + Nothing + \value Type.SomeType + Something +*/ + +/*! + \qmlproperty int Type::group.first + \qmlproperty int Type::group.second + \qmlproperty int Type::group.third + + \brief A property group. +*/ + +/*! + \qmlmethod Type Type::copy(a) + + Returns another Type based on \a a. +*/ + +/*! + \qmlsignal Type::completed(int status) + + This signal is emitted when the operation completed with \a status. +*/ + +/*! + \qmlattachedsignal Type::configured() + + This attached signal is emitted when the type was configured. +*/ diff --git a/tests/auto/qdoc/generatedoutput/testqml.qdocconf b/tests/auto/qdoc/generatedoutput/testqml.qdocconf index 769c3d627..00d12a463 100644 --- a/tests/auto/qdoc/generatedoutput/testqml.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testqml.qdocconf @@ -1,10 +1,15 @@ +include(testcpp.qdocconf) project = Test description = "A test project for QDoc build artifacts" -moduleheader= outputdir = ./html -exampledirs = . -sources.fileextensions = \ - examples.qdoc +exampledirs = qml + +headerdirs += . +sourcedirs += qml + +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" 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 6c8211125..191671361 100644 --- a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp +++ b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp @@ -155,7 +155,17 @@ void tst_generatedOutput::htmlFromQml() { testAndCompare("testqml.qdocconf", "test-componentset-example.html " - "uicomponents-qmlmodule.html"); + "uicomponents-qmlmodule.html " + "qdoc-test-qmlmodule.html " + "qml-qdoc-test-abstractparent.html " + "qml-qdoc-test-child.html " + "qml-qdoc-test-doctest.html " + "qml-qdoc-test-type-members.html " + "qml-qdoc-test-type.html " + "qml-uicomponents-progressbar.html " + "qml-uicomponents-switch.html " + "qml-uicomponents-tabwidget.html " + "qml-int.html"); } void tst_generatedOutput::htmlFromCppBug80259() |