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 /tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html | |
| parent | ba7da547208222ad023f13d4f95ba596689148f0 (diff) | |
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>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html')
| -rw-r--r-- | tests/auto/qdoc/generatedoutput/expected_output/qml-uicomponents-switch.html | 69 |
1 files changed, 69 insertions, 0 deletions
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> |