summaryrefslogtreecommitdiff
path: root/tests/scanner/annotationparser/gtkdoc/gobject/giface.c.xml
blob: ea09d1264f3e30a1f5fe854e6e98c4ed924ea938 (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
<?xml version="1.0" encoding="UTF-8"?>

<tests>

<test>
  <commentblock><![CDATA[/**
 * SECTION:iface
 * @title: GtkdocIface
 * @short_description: interface for gtk-doc unit test
 * @see_also: #GtkdocObject
 *
 * This file contains non-sense code for the sole purpose of testing the docs.
 * We can link to the #GtkdocIface:itest property and the #GtkdocIface::itest
 * signal.
 * An instance can be configured using the gtkdoc_iface_configure() function.
 *
 * I can haz pictures too!
 * <mediaobject>
 *   <imageobject><imagedata fileref="home.png" format="PNG"/></imageobject>
 *   <caption><para>Home sweet home.</para></caption>
 * </mediaobject>
 *
 * Just incase you wonder, special caracters can be escaped with a \ like in \%
 * or \# or even \@.
 */]]></commentblock>
  <docblock>
    <identifier>
      <name>SECTION:iface</name>
    </identifier>
    <parameters>
      <parameter>
        <name>title</name>
        <description>GtkdocIface</description>
      </parameter>
      <parameter>
        <name>short_description</name>
        <description>interface for gtk-doc unit test</description>
      </parameter>
      <parameter>
        <name>see_also</name>
        <description>#GtkdocObject</description>
      </parameter>
    </parameters>
    <description><![CDATA[This file contains non-sense code for the sole purpose of testing the docs.
We can link to the #GtkdocIface:itest property and the #GtkdocIface::itest
signal.
An instance can be configured using the gtkdoc_iface_configure() function.

I can haz pictures too!
<mediaobject>
  <imageobject><imagedata fileref="home.png" format="PNG"/></imageobject>
  <caption><para>Home sweet home.</para></caption>
</mediaobject>

Just incase you wonder, special caracters can be escaped with a \ like in \%
or \# or even \@.]]></description>
  </docblock>
</test>

<test>
  <commentblock>/**
 * SECTION:iface2
 * @title: GtkdocIface2
 * @short_description: interface with a prerequisite for gtk-doc unit test
 * @see_also: #GtkdocObject, #GtkdocIface
 *
 * This file contains non-sense code for the sole purpose of testing the docs.
 */</commentblock>
  <docblock>
    <identifier>
      <name>SECTION:iface2</name>
    </identifier>
    <parameters>
      <parameter>
        <name>title</name>
        <description>GtkdocIface2</description>
      </parameter>
      <parameter>
        <name>short_description</name>
        <description>interface with a prerequisite for gtk-doc unit test</description>
      </parameter>
      <parameter>
        <name>see_also</name>
        <description>#GtkdocObject, #GtkdocIface</description>
      </parameter>
    </parameters>
    <description>This file contains non-sense code for the sole purpose of testing the docs.</description>
  </docblock>
</test>

<test>
  <commentblock>/**
 * gtkdoc_iface_configure:
 * @config: settings
 *
 * Configure a new instance
 *
 * Returns: %TRUE for sucess or %FALSE in case of an error
 *
 * Since: 0.1
 */</commentblock>
  <docblock>
    <identifier>
      <name>gtkdoc_iface_configure</name>
    </identifier>
    <parameters>
      <parameter>
        <name>config</name>
        <description>settings</description>
      </parameter>
    </parameters>
    <description>Configure a new instance</description>
    <tags>
      <tag>
        <name>returns</name>
        <description>%TRUE for sucess or %FALSE in case of an error</description>
      </tag>
      <tag>
        <name>since</name>
        <description>0.1</description>
      </tag>
    </tags>
  </docblock>
</test>

<test>
  <commentblock>/**
     * GtkdocIface::itest:
     * @self: myself
     *
     * The event has been triggered.
     */</commentblock>
  <docblock>
    <identifier>
      <name>GtkdocIface::itest</name>
    </identifier>
    <parameters>
      <parameter>
        <name>self</name>
        <description>myself</description>
      </parameter>
    </parameters>
    <description>The event has been triggered.</description>
  </docblock>
</test>

</tests>