DocTest QML Type
Test
A test project for QDoc build artifacts
Represents a doc test case.
This type was introduced in QDoc.Test 0.9.
Import Statement
import QDoc.Test 1.1
Since:
QDoc.Test 0.9
Detailed Description
Introduction
A documentation test case, itself documented inline in DocTest.qml.
Property Documentation
[default: true] active : bool
bool
active
writable
public
active
unspecified
Whether the test is active.
See Also
See also
name
[required] name : string
string
name
writable
required
public
active
unspecified
Name of the test.
DocTest {
name: "test"
// ...
}
Signal Documentation
completed()
The corresponding handler is onCompleted.
foo(var bar)
Signal with parameter bar.
The corresponding handler is onFoo.
itsHappening(bool really)
Signals that something is really happening.
The corresponding handler is onItsHappening.
Method Documentation
[since QDoc.Test 1.0] fail(message = "oops")
Fails the current test case, with the optional message.
This method was introduced in QDoc.Test 1.0.
fail_hard(msg = "facepalm", option = 123)
Fails the current test case, hard.
Prints out msg.
Accepts a random option.