| <!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> |
| <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> |
| <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> |
| <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> |
