blob: 59ed97a011e6799c79513a89f32b50ebb5a29200 (
plain)
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<?xml version="1.0" encoding="UTF-8"?>
<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en">
<db:info>
<db:title>Type QML Type</db:title>
<db:productname>Test</db:productname>
<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev>
<db:abstract>
<db:para>A QML type documented in a .cpp file.</db:para>
</db:abstract>
</db:info>
<db:variablelist>
<db:varlistentry>
<db:term>Import Statement</db:term>
<db:listitem>
<db:para>import QDoc.Test 1.1</db:para>
</db:listitem>
</db:varlistentry>
<db:varlistentry>
<db:term>Instantiates:</db:term>
<db:listitem>
<db:para><db:link xlink:href="testqdoc-test.xml">Test</db:link></db:para>
</db:listitem>
</db:varlistentry>
</db:variablelist>
<db:section xml:id="details">
<db:title>Detailed Description</db:title>
</db:section>
<db:section xml:id="property-documentation">
<db:title>Property Documentation</db:title>
<db:para>A group of properties sharing a documentation comment.</db:para>
<db:section xml:id="group-prop">
<db:title>group group</db:title>
<db:bridgehead renderas="sect2" xml:id="group.first-prop">group.first : int</db:bridgehead>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>group.first</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo db:role="access">public</db:synopsisinfo>
<db:synopsisinfo db:role="status">active</db:synopsisinfo>
<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
<db:synopsisinfo db:role="module">Test</db:synopsisinfo>
</db:fieldsynopsis>
<db:bridgehead renderas="sect2" xml:id="group.second-prop">group.second : int</db:bridgehead>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>group.second</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo db:role="access">public</db:synopsisinfo>
<db:synopsisinfo db:role="status">active</db:synopsisinfo>
<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
<db:synopsisinfo db:role="module">Test</db:synopsisinfo>
</db:fieldsynopsis>
<db:bridgehead renderas="sect2" xml:id="group.third-prop">group.third : int</db:bridgehead>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>group.third</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo db:role="access">public</db:synopsisinfo>
<db:synopsisinfo db:role="status">active</db:synopsisinfo>
<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
<db:synopsisinfo db:role="module">Test</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>A property group.</db:para>
</db:section>
<db:section xml:id="id-prop">
<db:title>[read-only] id : int</db:title>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>id</db:varname>
<db:modifier>[read-only]</db:modifier>
<db:synopsisinfo db:role="access">public</db:synopsisinfo>
<db:synopsisinfo db:role="status">active</db:synopsisinfo>
<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
<db:synopsisinfo db:role="module">Test</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>A read-only property.</db:para>
</db:section>
<db:section xml:id="name-prop">
<db:title>name : string</db:title>
<db:fieldsynopsis>
<db:type>string</db:type>
<db:varname>name</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo db:role="access">public</db:synopsisinfo>
<db:synopsisinfo db:role="status">active</db:synopsisinfo>
<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
<db:synopsisinfo db:role="module">Test</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>Name of the Test.</db:para>
</db:section>
</db:section>
<db:section xml:id="attached-property-documentation">
<db:title>Attached Property Documentation</db:title>
<db:section xml:id="type-attached-prop">
<db:title>Type.type : enumeration</db:title>
<db:fieldsynopsis>
<db:type>enumeration</db:type>
<db:varname>Type.type</db:varname>
<db:modifier>attached</db:modifier>
<db:modifier>writable</db:modifier>
<db:synopsisinfo db:role="access">public</db:synopsisinfo>
<db:synopsisinfo db:role="status">active</db:synopsisinfo>
<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
<db:synopsisinfo db:role="module">Test</db:synopsisinfo>
</db:fieldsynopsis>
<db:informaltable>
<db:thead>
<db:tr>
<db:th>Constant</db:th>
<db:th>Description</db:th>
</db:tr>
</db:thead>
<db:tr>
<db:td>
<db:para>Type.NoType</db:para>
</db:td>
<db:td>
<db:para>Nothing</db:para>
</db:td>
</db:tr>
<db:tr>
<db:td>
<db:para>Type.SomeType</db:para>
</db:td>
<db:td>
<db:para>Something</db:para>
</db:td>
</db:tr>
</db:informaltable>
</db:section>
</db:section>
<db:section xml:id="signal-documentation">
<db:title>Signal Documentation</db:title>
<db:section xml:id="completed-signal">
<db:title>completed(<db:emphasis>status</db:emphasis>)</db:title>
<db:para>This signal is emitted when the operation completed with <db:code role="parameter">status</db:code>.</db:para>
<db:note>
<db:para>The corresponding handler is <db:code>onCompleted</db:code>.</db:para>
</db:note>
</db:section>
</db:section>
<db:section xml:id="attached-signal-documentation">
<db:title>Attached Signal Documentation</db:title>
<db:section xml:id="configured-signal">
<db:title>configured()</db:title>
<db:para>This attached signal is emitted when the type was configured.</db:para>
<db:note>
<db:para>The corresponding handler is <db:code>onConfigured</db:code>.</db:para>
</db:note>
</db:section>
</db:section>
<db:section xml:id="method-documentation">
<db:title>Method Documentation</db:title>
<db:para>Enables or disables this type.</db:para>
<db:section xml:id="copy-method">
<db:title>Type copy(<db:emphasis>a</db:emphasis>)</db:title>
<db:para>Returns another Type based on <db:code role="parameter">a</db:code>.</db:para>
</db:section>
</db:section>
</db:article>
|
