summaryrefslogtreecommitdiff
path: root/tests/scanner/annotationparser/gtkdoc/gobject/gobject.c.xml
blob: 1f619408819484328bb8e0b7b1b84343851ba8c0 (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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
<?xml version="1.0" encoding="UTF-8"?>

<tests xmlns="http://schemas.gnome.org/gobject-introspection/2013/test">

<test>
  <input><![CDATA[/**
 * SECTION:object
 * @title: GtkdocObject
 * @short_description: class for gtk-doc unit test
 * @see_also: #GtkdocIface
 * @Image: object.png
 *
 * This file contains non-sense code for the sole purpose of testing the docs.
 * We can link to the #GtkdocObject:otest property and the #GtkdocObject::otest
 * signal.
 *
 * When subclassing it is useful to override the #GtkdocObjectClass.test()
 * method. The #GtkdocObjectClass.foo_bar() vmethod lets you refine your
 * frobnicator.
 *
 * A new instance can be created using the gtkdoc_object_new() function. The
 * whole lifecycle usualy looks like shown in this example:
 * |[{{!-- language="C" --!}}
 * GObject *myobj;
 *
 * myobj = gtkdoc_object_new();
 * // do somehing
 * g_object_unref (myobj);
 * ]|
 *
 * # Examples #
 *
 * You can also change parameters:
 * <informalexample>
 * <programlisting language="c"><xi:include xmlns:xi="http://www.w3.org/2003/XInclude" parse="text" href="../../examples/gobject.c" /></programlisting>
 * </informalexample>
 *
 * This example serves two main purposes:
 * - testing conversion (long description
 *   follows here)
 * - catching bugs
 * - having an example
 *
 * Nothing more to say.
 */]]></input>
  <parser>
    <docblock>
      <identifier>
        <name>SECTION:object</name>
      </identifier>
      <parameters>
        <parameter>
          <name>title</name>
          <description>GtkdocObject</description>
        </parameter>
        <parameter>
          <name>short_description</name>
          <description>class for gtk-doc unit test</description>
        </parameter>
        <parameter>
          <name>see_also</name>
          <description>#GtkdocIface</description>
        </parameter>
        <parameter>
          <name>Image</name>
          <description>object.png</description>
        </parameter>
      </parameters>
      <description><![CDATA[This file contains non-sense code for the sole purpose of testing the docs.
We can link to the #GtkdocObject:otest property and the #GtkdocObject::otest
signal.

When subclassing it is useful to override the #GtkdocObjectClass.test()
method. The #GtkdocObjectClass.foo_bar() vmethod lets you refine your
frobnicator.

A new instance can be created using the gtkdoc_object_new() function. The
whole lifecycle usualy looks like shown in this example:
|[{{!-- language="C" --!}}
GObject *myobj;

myobj = gtkdoc_object_new();
// do somehing
g_object_unref (myobj);
]|

# Examples #

You can also change parameters:
<informalexample>
<programlisting language="c"><xi:include xmlns:xi="http://www.w3.org/2003/XInclude" parse="text" href="../../examples/gobject.c" /></programlisting>
</informalexample>

This example serves two main purposes:
- testing conversion (long description
  follows here)
- catching bugs
- having an example

Nothing more to say.]]></description>
    </docblock>
  </parser>
</test>

<test>
  <input>/**
 * SECTION:object2
 * @title: GtkdocObject2
 * @short_description: class with interface for gtk-doc unit test
 * @see_also: #GtkdocIface
 *
 * This file contains non-sense code for the sole purpose of testing the docs.
 *
 * Internals
 * =========
 *
 * All the internal details go here or not:
 * - single item list
 */</input>
  <parser>
    <docblock>
      <identifier>
        <name>SECTION:object2</name>
      </identifier>
      <parameters>
        <parameter>
          <name>title</name>
          <description>GtkdocObject2</description>
        </parameter>
        <parameter>
          <name>short_description</name>
          <description>class with interface for gtk-doc unit test</description>
        </parameter>
        <parameter>
          <name>see_also</name>
          <description>#GtkdocIface</description>
        </parameter>
      </parameters>
      <description>This file contains non-sense code for the sole purpose of testing the docs.

Internals
=========

All the internal details go here or not:
- single item list</description>
    </docblock>
  </parser>
</test>

<test>
  <input><![CDATA[/**
 * gtkdoc_object_new:
 *
 * Create a new instance
 * <note><para>
 *   This will only work if you have called g_type_init() before.
 * </para></note>
 * Returns: the instance or %NULL in case of an error
 *
 * Since: 0.1
 */]]></input>
  <parser>
    <docblock>
      <identifier>
        <name>gtkdoc_object_new</name>
      </identifier>
      <description><![CDATA[Create a new instance
<note><para>
  This will only work if you have called g_type_init() before.
</para></note>]]></description>
      <tags>
        <tag>
          <name>returns</name>
          <description>the instance or %NULL in case of an error</description>
        </tag>
        <tag>
          <name>since</name>
          <description>0.1</description>
        </tag>
      </tags>
    </docblock>
  </parser>
</test>

<test>
  <input><![CDATA[/**
 * gtkdoc_object_set_otest:
 * @self: the object
 * @value: the new otest value, whose description extends further than one
 *  line will allow
 *
 * Set the #GtkdocObject:otest property.
 *
 * Deprecated: Use g_object_set(obj,&quot;otest&quot;,value,NULL); instead.
 *
 * Since: 0.5
 */]]></input>
  <parser>
    <docblock>
      <identifier>
        <name>gtkdoc_object_set_otest</name>
      </identifier>
      <parameters>
        <parameter>
          <name>self</name>
          <description>the object</description>
        </parameter>
        <parameter>
          <name>value</name>
          <description>the new otest value, whose description extends further than one line will allow</description>
        </parameter>
      </parameters>
      <description>Set the #GtkdocObject:otest property.</description>
      <tags>
        <tag>
          <name>deprecated</name>
          <description><![CDATA[Use g_object_set(obj,&quot;otest&quot;,value,NULL); instead.]]></description>
        </tag>
        <tag>
          <name>since</name>
          <description>0.5</description>
        </tag>
      </tags>
    </docblock>
  </parser>
</test>

<test>
  <input><![CDATA[/**
 * gtkdoc_object_frobnicate:
 * @self: the object
 * @n: number of iterations
 *
 * Frobnicate the content of @self @n times. This implements a
 * complex algorithm (http://en.wikipedia.org/wiki/Algorithm).
 * <footnote>
 *  <para>
 *    Negative frobnication can lead to unexpected behaviour.
 *  </para>
 * </footnote>
 *
 * Since: 0.5
 */]]></input>
  <parser>
    <docblock>
      <identifier>
        <name>gtkdoc_object_frobnicate</name>
      </identifier>
      <parameters>
        <parameter>
          <name>self</name>
          <description>the object</description>
        </parameter>
        <parameter>
          <name>n</name>
          <description>number of iterations</description>
        </parameter>
      </parameters>
      <description><![CDATA[Frobnicate the content of @self @n times. This implements a
complex algorithm (http://en.wikipedia.org/wiki/Algorithm).
<footnote>
 <para>
   Negative frobnication can lead to unexpected behaviour.
 </para>
</footnote>]]></description>
      <tags>
        <tag>
          <name>since</name>
          <description>0.5</description>
        </tag>
      </tags>
    </docblock>
  </parser>
</test>

<test>
  <input>/**
 * gtkdoc_object_fooify:
 * @self: the object
 * @...: a NULL terminated list of arguments
 *
 * Fooify the content of @self.
 *
 * Returns: %TRUE for success
 */</input>
  <parser>
    <docblock>
      <identifier>
        <name>gtkdoc_object_fooify</name>
      </identifier>
      <parameters>
        <parameter>
          <name>self</name>
          <description>the object</description>
        </parameter>
        <parameter>
          <name>...</name>
          <description>a NULL terminated list of arguments</description>
        </parameter>
      </parameters>
      <description>Fooify the content of @self.</description>
      <tags>
        <tag>
          <name>returns</name>
          <description>%TRUE for success</description>
        </tag>
      </tags>
    </docblock>
  </parser>
</test>

<test>
  <input>/**
   * GtkdocObject::otest:
   * @self: myself
   *
   * The event has been triggered.
   */</input>
  <parser>
    <docblock>
      <identifier>
        <name>GtkdocObject::otest</name>
      </identifier>
      <parameters>
        <parameter>
          <name>self</name>
          <description>myself</description>
        </parameter>
      </parameters>
      <description>The event has been triggered.</description>
    </docblock>
  </parser>
</test>

<test>
  <input>/**
   * GtkdocObject::dep-otest:
   * @self: myself
   *
   * The event has been triggered.
   *
   * Deprecated: Use the #GtkdocObject::otest signal instead.
   */</input>
  <parser>
    <docblock>
      <identifier>
        <name>GtkdocObject::dep-otest</name>
      </identifier>
      <parameters>
        <parameter>
          <name>self</name>
          <description>myself</description>
        </parameter>
      </parameters>
      <description>The event has been triggered.</description>
      <tags>
        <tag>
          <name>deprecated</name>
          <description>Use the #GtkdocObject::otest signal instead.</description>
        </tag>
      </tags>
    </docblock>
  </parser>
</test>

<test>
  <input>/**
   * GtkdocObject::strings-changed:
   *
   * Something has happened.
   */</input>
  <parser>
    <docblock>
      <identifier>
        <name>GtkdocObject::strings-changed</name>
      </identifier>
      <description>Something has happened.</description>
    </docblock>
  </parser>
</test>

<test>
  <input>/**
   * GtkdocObject::variant-changed:
   *
   * Something has happened.
   */</input>
  <parser>
    <docblock>
      <identifier>
        <name>GtkdocObject::variant-changed</name>
      </identifier>
      <description>Something has happened.</description>
    </docblock>
  </parser>
</test>

<test>
  <input>/**
   * GtkdocObject:otest:
   *
   * Since: 0.1
   */</input>
  <parser>
    <docblock>
      <identifier>
        <name>GtkdocObject:otest</name>
      </identifier>
      <tags>
        <tag>
          <name>since</name>
          <description>0.1</description>
        </tag>
      </tags>
    </docblock>
  </parser>
</test>

<test>
  <input>/**
   * GtkdocObject:dep-otest:
   *
   * Deprecated: use #GtkdocObject:otest property
   */</input>
  <parser>
    <docblock>
      <identifier>
        <name>GtkdocObject:dep-otest</name>
      </identifier>
      <tags>
        <tag>
          <name>deprecated</name>
          <description>use #GtkdocObject:otest property</description>
        </tag>
      </tags>
    </docblock>
  </parser>
</test>

</tests>