1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
<!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="#signals">Signals</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#introduction">Introduction</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title" translate="no">DocTest QML Type</h1>
<span class="subtitle" translate="no"></span>
<!-- $$$DocTest-brief -->
<p>Represents a doc test case. <a href="#details">More...</a></p>
<!-- @@@DocTest -->
<div class="table"><table class="alignedsummary" translate="no">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> QDoc.Test 0.9</td></tr></table></div><ul>
<li><a href="qml-qdoc-test-doctest-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn" translate="no"><b><b><a href="qml-qdoc-test-doctest.html#active-prop" translate="no">active</a></b></b> : bool</li>
<li class="fn" translate="no"><b><b><a href="qml-qdoc-test-doctest.html#name-prop" translate="no">name</a></b></b> : string</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn" translate="no"><b><b><a href="qml-qdoc-test-doctest.html#completed-signal" translate="no">completed</a></b></b>()</li>
<li class="fn" translate="no"><b><b><a href="qml-qdoc-test-doctest.html#foo-signal" translate="no">foo</a></b></b>(var <i>bar</i>)</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn" translate="no"><b><b><a href="qml-qdoc-test-doctest.html#fail-method" translate="no">fail</a></b></b>(<i>message</i>)</li>
<li class="fn" translate="no"><b><b><a href="qml-qdoc-test-doctest.html#fail_hard-method" translate="no">fail_hard</a></b></b>(<i>msg</i>, <i>option</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" translate="no">
<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" translate="no">name</a>.</p>
</div></div><!-- @@@active -->
<br/>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto" translate="no">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="name-prop">
<td class="tblQmlPropNode"><p>
<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" translate="no"><span class="type"><a href="qml-qdoc-test-doctest.html" translate="no">DocTest</a></span> {
<span class="name">name</span>: <span class="string">"test"</span>
<span class="comment">// ...</span>
}</pre>
</div></div><!-- @@@name -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$completed[overload1]$$$completed -->
<div class="qmlitem"><div class="qmlproto" translate="no">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="completed-signal">
<td class="tblQmlFuncNode"><p>
<a name="completed-signal"></a><span class="name">completed</span>()</p></td></tr>
</table></div></div>
<div class="qmldoc"><p><b>Note: </b>The corresponding handler is <code translate="no">onCompleted</code>.</p>
</div></div><!-- @@@completed -->
<br/>
<!-- $$$foo[overload1]$$$foovar -->
<div class="qmlitem"><div class="qmlproto" translate="no">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="foo-signal">
<td class="tblQmlFuncNode"><p>
<a name="foo-signal"></a><span class="name">foo</span>(<span class="type">var</span> <i>bar</i>)</p></td></tr>
</table></div></div>
<div class="qmldoc"><p>Signal with parameter <i translate="no">bar</i>.</p>
<p><b>Note: </b>The corresponding handler is <code translate="no">onFoo</code>.</p>
</div></div><!-- @@@foo -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$fail[overload1]$$$fail -->
<div class="qmlitem"><div class="qmlproto" translate="no">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="fail-method">
<td class="tblQmlFuncNode"><p>
<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 translate="no">message</i>.</p>
<p>This method was introduced in QDoc.Test 1.0.</p>
</div></div><!-- @@@fail -->
<br/>
<!-- $$$fail_hard[overload1]$$$fail_hard -->
<div class="qmlitem"><div class="qmlproto" translate="no">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="fail_hard-method">
<td class="tblQmlFuncNode"><p>
<a name="fail_hard-method"></a><span class="name">fail_hard</span>(<i>msg</i> = "facepalm", <i>option</i> = 123)</p></td></tr>
</table></div></div>
<div class="qmldoc"><p>Fails the current test case, hard.</p>
<ul>
<li>Prints out <i translate="no">msg</i>.</li>
<li>Accepts a random <i translate="no">option</i>.</li>
</ul>
</div></div><!-- @@@fail_hard -->
<br/>
</body>
</html>
|
