blob: 9be3db76f14f63a7a68b1ad5f20c215075492a60 (
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
<?xml version="1.0" encoding="UTF-8"?>
<tests>
<test>
<commentblock>/**
* SECTION:tester
* @short_description: module for gtk-doc unit test
*
* This file contains non-sense code for the sole purpose of testing the docs.
*/</commentblock>
<docblock>
<identifier>
<name>SECTION:tester</name>
</identifier>
<parameters>
<parameter>
<name>short_description</name>
<description>module for gtk-doc unit test</description>
</parameter>
</parameters>
<description>This file contains non-sense code for the sole purpose of testing the docs.</description>
</docblock>
</test>
<test>
<commentblock>/**
* annotation_array_length:
* @list: a #GtkListStore
* @n_columns: number of columns
* @types: (array length=n_columns): list of types
*
* Document parameter relation for array length.
*/</commentblock>
<docblock>
<identifier>
<name>annotation_array_length</name>
</identifier>
<parameters>
<parameter>
<name>list</name>
<description>a #GtkListStore</description>
</parameter>
<parameter>
<name>n_columns</name>
<description>number of columns</description>
</parameter>
<parameter>
<name>types</name>
<annotations>
<annotation>
<name>array</name>
<options>
<option>
<name>length</name>
<value>n_columns</value>
</option>
</options>
</annotation>
</annotations>
<description>list of types</description>
</parameter>
</parameters>
<description>Document parameter relation for array length.</description>
</docblock>
</test>
<test>
<commentblock>/**
* annotation_nullable:
* @uri: a uri
* @label: (allow-none): an optional string, which is used in ways too
* complicated to describe in a single line, making it necessary to wrap it
*
* Document optional parameters.
*
* Returns: (transfer full) (allow-none): Returns stuff which you have to
* free after use, whose description is also rather long
*/</commentblock>
<docblock>
<identifier>
<name>annotation_nullable</name>
</identifier>
<parameters>
<parameter>
<name>uri</name>
<description>a uri</description>
</parameter>
<parameter>
<name>label</name>
<annotations>
<annotation>
<name>allow-none</name>
</annotation>
</annotations>
<description>an optional string, which is used in ways too complicated to describe in a single line, making it necessary to wrap it</description>
</parameter>
</parameters>
<description>Document optional parameters.</description>
<tags>
<tag>
<name>returns</name>
<annotations>
<annotation>
<name>transfer</name>
<options>
<option>
<name>full</name>
</option>
</options>
</annotation>
<annotation>
<name>allow-none</name>
</annotation>
</annotations>
<description>Returns stuff which you have to free after use, whose description is also rather long</description>
</tag>
</tags>
</docblock>
</test>
<test>
<commentblock>/**
* annotation_elementtype:
* @list: (element-type GObject): list of #GObject instances to search
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/</commentblock>
<docblock>
<identifier>
<name>annotation_elementtype</name>
</identifier>
<parameters>
<parameter>
<name>list</name>
<annotations>
<annotation>
<name>element-type</name>
<options>
<option>
<name>GObject</name>
</option>
</options>
</annotation>
</annotations>
<description>list of #GObject instances to search</description>
</parameter>
</parameters>
<description>Document optional parameters.</description>
<tags>
<tag>
<name>returns</name>
<description>%TRUE for success</description>
</tag>
</tags>
</docblock>
</test>
<test>
<commentblock>/**
* annotation_elementtype_transfer:
* @list: (element-type utf8) (transfer full): list of #GObject instances to search
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/</commentblock>
<docblock>
<identifier>
<name>annotation_elementtype_transfer</name>
</identifier>
<parameters>
<parameter>
<name>list</name>
<annotations>
<annotation>
<name>element-type</name>
<options>
<option>
<name>utf8</name>
</option>
</options>
</annotation>
<annotation>
<name>transfer</name>
<options>
<option>
<name>full</name>
</option>
</options>
</annotation>
</annotations>
<description>list of #GObject instances to search</description>
</parameter>
</parameters>
<description>Document optional parameters.</description>
<tags>
<tag>
<name>returns</name>
<description>%TRUE for success</description>
</tag>
</tags>
</docblock>
</test>
<test>
<commentblock>/**
* annotation_elementtype_returns:
*
* Document optional parameters.
*
* Returns: (element-type GObject): A list of #GObject instances.
*/</commentblock>
<docblock>
<identifier>
<name>annotation_elementtype_returns</name>
</identifier>
<description>Document optional parameters.</description>
<tags>
<tag>
<name>returns</name>
<annotations>
<annotation>
<name>element-type</name>
<options>
<option>
<name>GObject</name>
</option>
</options>
</annotation>
</annotations>
<description>A list of #GObject instances.</description>
</tag>
</tags>
</docblock>
</test>
<test>
<commentblock>/**
* annotation_outparams:
* @list: (out) (transfer none): a pointer to take a list
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/</commentblock>
<docblock>
<identifier>
<name>annotation_outparams</name>
</identifier>
<parameters>
<parameter>
<name>list</name>
<annotations>
<annotation>
<name>out</name>
</annotation>
<annotation>
<name>transfer</name>
<options>
<option>
<name>none</name>
</option>
</options>
</annotation>
</annotations>
<description>a pointer to take a list</description>
</parameter>
</parameters>
<description>Document optional parameters.</description>
<tags>
<tag>
<name>returns</name>
<description>%TRUE for success</description>
</tag>
</tags>
</docblock>
</test>
<test>
<commentblock>/**
* annotation_skip: (skip)
* @list: a pointer to take a list
*
* Documentation for this function.
*/</commentblock>
<docblock>
<identifier>
<name>annotation_skip</name>
<annotations>
<annotation>
<name>skip</name>
</annotation>
</annotations>
</identifier>
<parameters>
<parameter>
<name>list</name>
<description>a pointer to take a list</description>
</parameter>
</parameters>
<description>Documentation for this function.</description>
</docblock>
</test>
<test>
<commentblock>/**
* annotation_scope:
* @callback: (scope async): a callback
* @user_data: data to pass to callback
*
* Documentation for this function.
*/</commentblock>
<docblock>
<identifier>
<name>annotation_scope</name>
</identifier>
<parameters>
<parameter>
<name>callback</name>
<annotations>
<annotation>
<name>scope</name>
<options>
<option>
<name>async</name>
</option>
</options>
</annotation>
</annotations>
<description>a callback</description>
</parameter>
<parameter>
<name>user_data</name>
<description>data to pass to callback</description>
</parameter>
</parameters>
<description>Documentation for this function.</description>
</docblock>
</test>
</tests>
|
