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
|
<?xml version="1.0" encoding="UTF-8"?>
<tests xmlns="http://schemas.gnome.org/gobject-introspection/2013/test">
<test>
<input>/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @...: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
*
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/</input>
<parser>
<docblock>
<identifier>
<name>function_name</name>
</identifier>
<parameters>
<parameter>
<name>par1</name>
<description>description of parameter 1. These can extend over more than
one line.</description>
</parameter>
<parameter>
<name>par2</name>
<description>description of parameter 2</description>
</parameter>
<parameter>
<name>...</name>
<description>a %NULL-terminated list of bars</description>
</parameter>
</parameters>
<description>The function description goes here. You can use @par1 to refer to parameters
so that they are highlighted in the output. You can also use %constant
for constants, function_name2() for functions and #GtkWidget for links to
other declarations (which may be documented elsewhere).</description>
<tags>
<tag>
<name>returns</name>
<description>an integer.</description>
</tag>
<tag>
<name>since</name>
<value>2.2</value>
</tag>
<tag>
<name>deprecated</name>
<value>2.18</value>
<description>Use other_function() instead.</description>
</tag>
</tags>
</docblock>
</parser>
<output>/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @...: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/</output>
</test>
<test>
<!--
gtkdoc-mkdb has deprecated named __VA_ARGS__ parameter notation.
But there is a gcc CPP extension that, for macros, makes it possible to give a more descriptive
name for the variable argument than simply __VA_ARGS__. See
http://gcc.gnu.org/onlinedocs/cpp/Variadic-Macros.html for more information.
Encountered in the wild in for example:
http://git.kernel.org/?p=bluetooth/bluez.git;a=blob;f=src/log.h;h=3d34fa3774e5400c030d29a264824fe0584de2a8;hb=HEAD#l44
-->
<input>/**
* DBG:
* @fmt: format string
* @arg...: list of arguments
*
* Simple macro around btd_debug() which also include the function
* name it is called in.
*/</input>
<parser>
<docblock>
<identifier>
<name>DBG</name>
</identifier>
<parameters>
<parameter>
<name>fmt</name>
<description>format string</description>
</parameter>
<parameter>
<name>...</name>
<description>list of arguments</description>
</parameter>
</parameters>
<description>Simple macro around btd_debug() which also include the function
name it is called in.</description>
</docblock>
<messages>
<message>4: Warning: Test: "@arg..." parameter is deprecated, please use "@..." instead:
* @arg...: list of arguments
^</message>
</messages>
</parser>
<output>/**
* DBG:
* @fmt: format string
* @...: list of arguments
*
* Simple macro around btd_debug() which also include the function
* name it is called in.
*/</output>
</test>
<test>
<!--
Deprecated @Vargargs parameter
-->
<input>/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @Varargs: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
*
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/</input>
<parser>
<docblock>
<identifier>
<name>function_name</name>
</identifier>
<parameters>
<parameter>
<name>par1</name>
<description>description of parameter 1. These can extend over more than
one line.</description>
</parameter>
<parameter>
<name>par2</name>
<description>description of parameter 2</description>
</parameter>
<parameter>
<name>...</name>
<description>a %NULL-terminated list of bars</description>
</parameter>
</parameters>
<description>The function description goes here. You can use @par1 to refer to parameters
so that they are highlighted in the output. You can also use %constant
for constants, function_name2() for functions and #GtkWidget for links to
other declarations (which may be documented elsewhere).</description>
<tags>
<tag>
<name>returns</name>
<description>an integer.</description>
</tag>
<tag>
<name>since</name>
<value>2.2</value>
</tag>
<tag>
<name>deprecated</name>
<value>2.18</value>
<description>Use other_function() instead.</description>
</tag>
</tags>
</docblock>
<messages>
<message>6: Warning: Test: "@Varargs" parameter is deprecated, please use "@..." instead:
* @Varargs: a %NULL-terminated list of bars
^</message>
</messages>
</parser>
<output>/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @...: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/</output>
</test>
<test>
<!--
Normal @vargargs parameter (usually seen for va_list)
-->
<input>/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @varargs: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
*
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/</input>
<parser>
<docblock>
<identifier>
<name>function_name</name>
</identifier>
<parameters>
<parameter>
<name>par1</name>
<description>description of parameter 1. These can extend over more than
one line.</description>
</parameter>
<parameter>
<name>par2</name>
<description>description of parameter 2</description>
</parameter>
<parameter>
<name>varargs</name>
<description>a %NULL-terminated list of bars</description>
</parameter>
</parameters>
<description>The function description goes here. You can use @par1 to refer to parameters
so that they are highlighted in the output. You can also use %constant
for constants, function_name2() for functions and #GtkWidget for links to
other declarations (which may be documented elsewhere).</description>
<tags>
<tag>
<name>returns</name>
<description>an integer.</description>
</tag>
<tag>
<name>since</name>
<value>2.2</value>
</tag>
<tag>
<name>deprecated</name>
<value>2.18</value>
<description>Use other_function() instead.</description>
</tag>
</tags>
</docblock>
</parser>
<output>/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @varargs: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/</output>
</test>
</tests>
|
