blob: 7acf1c95aea8c79cc35542aab8f0966f1fb4259e (
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
<?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>TestDerived Class</db:title>
<db:subtitle>TestQDoc::TestDerived</db:subtitle>
<db:productname>TestCPP</db:productname>
<db:titleabbrev>TestCPP Reference Documentation</db:titleabbrev>
<db:abstract>
<db:para>A derived class in a namespace.</db:para>
</db:abstract>
</db:info>
<db:variablelist>
<db:varlistentry>
<db:term>Header</db:term>
<db:listitem>
<db:para>TestDerived</db:para>
</db:listitem>
</db:varlistentry>
<db:varlistentry>
<db:term>CMake</db:term>
<db:listitem>
<db:para>find_package(Qt6 COMPONENT QDocTest)</db:para>
<db:para>target_link_libraries(mytarget PUBLIC Qt::QDocTest)</db:para>
</db:listitem>
</db:varlistentry>
<db:varlistentry>
<db:term>qmake</db:term>
<db:listitem>
<db:para>QT += testcpp</db:para>
</db:listitem>
</db:varlistentry>
<db:varlistentry>
<db:term>Inherits</db:term>
<db:listitem>
<db:para><db:link xlink:href="testqdoc-test.xml" xlink:role="class">TestQDoc::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="member-type-documentation">
<db:title>Member Type Documentation</db:title>
<db:section xml:id="DerivedType-alias">
<db:title>[alias] TestDerived::DerivedType</db:title>
<db:typedefsynopsis>
<db:type>DerivedType</db:type><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">TestCPP</db:synopsisinfo>
</db:typedefsynopsis>
<db:para>This is a type alias for <db:link xlink:href="testqdoc-test.xml#SomeType-typedef">TestQDoc::Test::SomeType</db:link>.</db:para>
<db:para>An aliased typedef.</db:para>
</db:section>
<db:section xml:id="NotTypedef-alias">
<db:title>[alias] TestDerived::NotTypedef</db:title>
<db:typedefsynopsis>
<db:type>NotTypedef</db:type><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">TestCPP</db:synopsisinfo>
</db:typedefsynopsis>
<db:para>This is a type alias for <db:code>int</db:code>.</db:para>
<db:para>I'm an alias, not a typedef.</db:para>
</db:section>
</db:section>
<db:section xml:id="property-documentation">
<db:title>Property Documentation</db:title>
<db:section xml:id="bindableProp-prop">
<db:title>[bindable] bindableProp : QString</db:title>
<db:fieldsynopsis>
<db:modifier>(Qt property)</db:modifier>
<db:type>QString</db:type>
<db:varname>bindableProp</db:varname>
<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">TestCPP</db:synopsisinfo>
<db:synopsisinfo db:role="getter">bindableProp</db:synopsisinfo>
<db:synopsisinfo db:role="setter">setBindableProp</db:synopsisinfo>
<db:synopsisinfo db:role="notifier">bindablePropChanged</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>This property supports <db:link xlink:href="https://wiki.qt.io/QProperty">QProperty</db:link> bindings.</db:para>
<db:para>Some property.</db:para>
</db:section>
<db:section xml:id="boolProp-prop">
<db:title>boolProp : bool</db:title>
<db:fieldsynopsis>
<db:modifier>(Qt property)</db:modifier>
<db:type>bool</db:type>
<db:varname>boolProp</db:varname>
<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">TestCPP</db:synopsisinfo>
<db:synopsisinfo db:role="getter">boolProp</db:synopsisinfo>
<db:synopsisinfo db:role="setter">setBoolProp</db:synopsisinfo>
<db:synopsisinfo db:role="resetter">resetBoolProp</db:synopsisinfo>
<db:synopsisinfo db:role="notifier">boolPropChanged</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>A boolean property.</db:para>
<db:para>
<db:emphasis role="bold">Access functions:
</db:emphasis>
</db:para>
<db:itemizedlist>
<db:listitem>
<db:para><db:type>bool</db:type> <db:emphasis role="bold"><db:link xlink:href="">boolProp</db:link></db:emphasis>()</db:para>
</db:listitem>
<db:listitem>
<db:para><db:type>void</db:type> <db:emphasis role="bold"><db:link xlink:href="">setBoolProp</db:link></db:emphasis>(<db:type>bool</db:type> <db:emphasis>b</db:emphasis>)</db:para>
</db:listitem>
<db:listitem>
<db:para><db:type>void</db:type> <db:emphasis role="bold"><db:link xlink:href="">resetBoolProp</db:link></db:emphasis>()</db:para>
</db:listitem>
</db:itemizedlist>
<db:para>
<db:emphasis role="bold">Notifier signal:
</db:emphasis>
</db:para>
<db:itemizedlist>
<db:listitem>
<db:para><db:type>void</db:type> <db:emphasis role="bold"><db:link xlink:href="">boolPropChanged</db:link></db:emphasis>()</db:para>
</db:listitem>
</db:itemizedlist>
</db:section>
<db:section xml:id="intProp-prop">
<db:title>[read-only] intProp : int* const</db:title>
<db:fieldsynopsis>
<db:modifier>(Qt property)</db:modifier>
<db:type>int*</db:type>
<db:varname>intProp</db:varname>
<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">TestCPP</db:synopsisinfo>
<db:synopsisinfo db:role="getter">getInt</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>An integer property.</db:para>
<db:para>
<db:emphasis role="bold">Access functions:
</db:emphasis>
</db:para>
<db:itemizedlist>
<db:listitem>
<db:para><db:type>int</db:type> *<db:emphasis role="bold"><db:link xlink:href="">getInt</db:link></db:emphasis>()</db:para>
</db:listitem>
</db:itemizedlist>
</db:section>
<db:section xml:id="someProp-prop">
<db:title>[bindable read-only] someProp : QString</db:title>
<db:fieldsynopsis>
<db:modifier>(Qt property)</db:modifier>
<db:type>QString</db:type>
<db:varname>someProp</db:varname>
<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">TestCPP</db:synopsisinfo>
<db:synopsisinfo db:role="getter">someProp</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>This property supports <db:link xlink:href="https://wiki.qt.io/QProperty">QProperty</db:link> bindings.</db:para>
<db:para>Another property.</db:para>
</db:section>
</db:section>
<db:section xml:id="member-function-documentation">
<db:title>Member Function Documentation</db:title>
<db:section xml:id="virtualFun">
<db:title>[override virtual] TestDerived::void virtualFun()</db:title>
<db:methodsynopsis>
<db:modifier>virtual</db:modifier>
<db:void/>
<db:methodname>virtualFun</db:methodname>
<db:modifier>override</db:modifier>
<db:void/>
<db:synopsisinfo db:role="meta">plain</db:synopsisinfo>
<db:synopsisinfo db:role="signature">void virtualFun() override</db:synopsisinfo>
<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">TestCPP</db:synopsisinfo>
</db:methodsynopsis>
<db:para>Reimplements: <db:link xlink:href="testqdoc-test.xml#virtualFun" type="function">Test::virtualFun()</db:link>.</db:para>
</db:section>
</db:section></db:article>
|
