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
|
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
import QtQuick 2.0
/*!
\qmltype DocTest
\inherits Test
\inqmlmodule QDoc.Test
\brief Represents a doc test case.
\since QDoc.Test 0.9
\section1 Introduction
A documentation test case, itself documented inline in DocTest.qml.
*/
Item {
id: testCase
/*!
\qmlsignal QDocTest::completed
*/
signal completed
/*!
\qmlsignal DocTest::test(var bar)
Signal with parameter \a bar.
*/
signal foo(var bar)
/*!
\qmlproperty string DocTest::name
Name of the test.
\qml
DocTest {
name: "test"
// ...
}
\endqml
*/
property string name
/*!
Whether the test is active.
\sa name
*/
property bool active: true
/*! \internal */
property int doctest_internal: -1
/*!
\qmlmethod DocTest::fail(message = "oops")
\since QDoc.Test 1.0
Fails the current test case, with the optional \a message.
*/
function fail(msg) {
if (msg === undefined)
msg = "oops";
}
/*! \internal */
function doctest_fail(msg) {
if (msg === undefined)
msg = "";
}
/*!
\brief Fails the current test case, hard.
\list
\li Prints out \a msg.
\li Accepts a random \a option.
\endlist
*/
function fail_hard(msg = "facepalm", option = 123) {
}
}
|
