DocTest QML Type

Represents a doc test case. More...

• List of all members, including inherited members

Properties

• active : bool
• boolNumbers : list<bool>
• icon
  • icon.name : string
  • icon.source : string
• items : list<Item>
• name : string
• numbers : list<int>

Signals

• completed()
• foo(var bar)
• itsHappening(bool really)

Methods

• fail(message) (since QDoc.Test 1.0)
• fail_hard(msg, option)

Detailed Description

Introduction

A documentation test case, itself documented inline in DocTest.qml.

Property Documentation

active : bool [default: true]

Whether the test is active.

See also name.

boolNumbers : list<bool>

Property with overridden type.

icon group

Holds an icon.

items : list<Item>

List of items.

name : string [required]

Name of the test.

DocTest {
    name: "test"
    // ...
}

numbers : list<int>

Magic numbers.

Signal Documentation

completed()

foo(var bar)

Signal with parameter bar.

itsHappening(bool really)

Signals that something is really happening.

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.