blob: 7ebf440b440713a6ed490e91384725e9587b2c24 (
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
|
<?xml version="1.0" encoding="UTF-8"?>
<tests>
<test>
<commentblock>/*
* SECTION:tester_nodocs
* @short_description: module for gtk-doc unit test
* @title: GtkdocTesterNoDocs
*
* This file contains non-sense code for the sole purpose of testing the docs.
*/</commentblock>
</test>
<test>
<commentblock>/**
* SECTION:tester_nolongdesc
* @short_description: module for gtk-doc unit test
* @title: GtkdocTesterNoLongDesc
*/</commentblock>
<docblock>
<identifier>
<name>SECTION:tester_nolongdesc</name>
</identifier>
<parameters>
<parameter>
<name>short_description</name>
<description>module for gtk-doc unit test</description>
</parameter>
<parameter>
<name>title</name>
<description>GtkdocTesterNoLongDesc</description>
</parameter>
</parameters>
</docblock>
</test>
<test>
<commentblock>/**
* SECTION:tester_noshortdesc
* @title: GtkdocTesterNoShortDesc
*
* This file contains non-sense code for the sole purpose of testing the docs.
*/</commentblock>
<docblock>
<identifier>
<name>SECTION:tester_noshortdesc</name>
</identifier>
<parameters>
<parameter>
<name>title</name>
<description>GtkdocTesterNoShortDesc</description>
</parameter>
</parameters>
<description>This file contains non-sense code for the sole purpose of testing the docs.</description>
</docblock>
</test>
<test>
<commentblock>/**
* SECTION:tester_brokendocs
* @short_description: module for gtk-doc unit test
* @title: GtkdocTesterBrokenDocs
*
* This file contains non-sense code for the sole purpose of testing the docs.
*/</commentblock>
<docblock>
<identifier>
<name>SECTION:tester_brokendocs</name>
</identifier>
<parameters>
<parameter>
<name>short_description</name>
<description>module for gtk-doc unit test</description>
</parameter>
<parameter>
<name>title</name>
<description>GtkdocTesterBrokenDocs</description>
</parameter>
</parameters>
<description>This file contains non-sense code for the sole purpose of testing the docs.</description>
</docblock>
</test>
<test>
<commentblock>/**
* func_no_docs:
*/</commentblock>
<docblock>
<identifier>
<name>func_no_docs</name>
</identifier>
</docblock>
</test>
<test>
<commentblock>/**
* func_no_item_docs:
*
* Here we document the function but not the parameters.
*/</commentblock>
<docblock>
<identifier>
<name>func_no_item_docs</name>
</identifier>
<description>Here we document the function but not the parameters.</description>
</docblock>
</test>
<test>
<commentblock>/**
* func_incomplete_docs:
* @a: a value
*
* Here we document the function but not all the parameters.
*/</commentblock>
<docblock>
<identifier>
<name>func_incomplete_docs</name>
</identifier>
<parameters>
<parameter>
<name>a</name>
<description>a value</description>
</parameter>
</parameters>
<description>Here we document the function but not all the parameters.</description>
</docblock>
</test>
<test>
<commentblock>/**
* func_unused_docs:
* @a: a value
* @b: a value
* @c: an unexisting value
*
* Here we document the function and more than the actual parameters.
*/</commentblock>
<docblock>
<identifier>
<name>func_unused_docs</name>
</identifier>
<parameters>
<parameter>
<name>a</name>
<description>a value</description>
</parameter>
<parameter>
<name>b</name>
<description>a value</description>
</parameter>
<parameter>
<name>c</name>
<description>an unexisting value</description>
</parameter>
</parameters>
<description>Here we document the function and more than the actual parameters.</description>
</docblock>
</test>
</tests>
|
