tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension
[qemu.git] / tests / qapi-schema / doc-good.texi
1 @c AUTOMATICALLY GENERATED, DO NOT MODIFY
2
3 @section Section
4
5 @subsection Subsection
6
7 @strong{strong} @emph{with emphasis}
8 @code{var} @{in braces@}
9
10 @itemize @bullet
11 @item
12 List item one
13 @item
14 Two, multiple
15 lines
16
17 @item
18 Three
19 Still in list
20
21 @end itemize
22
23 Not in list
24
25 @itemize @minus
26 @item
27 Second list
28 Note: still in list
29
30 @end itemize
31
32 Note: not in list
33
34 @enumerate
35 @item
36 Third list
37 is numbered
38
39 @item
40 another item
41
42 @end enumerate
43
44 Returns: the King
45 Since: the first age
46 Notes:
47
48 @enumerate
49 @item
50 Lorem ipsum dolor sit amet
51
52 @item
53 Ut enim ad minim veniam
54
55 @end enumerate
56
57 Duis aute irure dolor
58
59 Example:
60
61 -> in
62 <- out
63 Examples:
64 @itemize @minus
65 @item
66 @strong{verbatim}
67 @item
68 @{braces@}
69 @end itemize
70
71
72
73 @deftp {Enum} Enum
74
75
76
77 @b{Values:}
78 @table @asis
79 @item @code{one}
80 The @emph{one} @{and only@}
81 @*@b{If:} @code{defined(IFONE)}
82 @item @code{two}
83 Not documented
84 @end table
85
86 @b{Features:}
87 @table @asis
88 @item @code{enum-feat}
89 Also @emph{one} @{and only@}
90 @end table
91 @code{two} is undocumented
92
93 @b{If:} @code{defined(IFCOND)}
94 @end deftp
95
96
97
98 @deftp {Object} Base
99
100
101
102 @b{Members:}
103 @table @asis
104 @item @code{base1: Enum}
105 the first member
106 @end table
107
108 @end deftp
109
110
111
112 @deftp {Object} Variant1
113
114 A paragraph
115
116 Another paragraph (but no @code{var}: line)
117
118 @b{Members:}
119 @table @asis
120 @item @code{var1: string}
121 Not documented
122 @*@b{If:} @code{defined(IFSTR)}
123 @end table
124
125 @b{Features:}
126 @table @asis
127 @item @code{variant1-feat}
128 a feature
129 @item @code{member-feat}
130 a member feature
131 @end table
132
133 @end deftp
134
135
136
137 @deftp {Object} Variant2
138
139
140
141 @end deftp
142
143
144
145 @deftp {Object} Object
146
147
148
149 @b{Members:}
150 @table @asis
151 @item The members of @code{Base}
152 @item The members of @code{Variant1} when @code{base1} is @t{"one"}
153 @item The members of @code{Variant2} when @code{base1} is @t{"two"} (@b{If:} @code{IFTWO})
154 @end table
155
156 @b{Features:}
157 @table @asis
158 @item @code{union-feat1}
159 a feature
160 @end table
161
162 @end deftp
163
164
165
166 @deftp {Object} SugaredUnion
167
168
169
170 @b{Members:}
171 @table @asis
172 @item @code{type}
173 One of @t{"one"}, @t{"two"}
174 @item @code{data: Variant1} when @code{type} is @t{"one"}
175 @item @code{data: Variant2} when @code{type} is @t{"two"} (@b{If:} @code{IFTWO})
176 @end table
177
178 @b{Features:}
179 @table @asis
180 @item @code{union-feat2}
181 a feature
182 @end table
183
184 @end deftp
185
186
187
188 @deftp {Alternate} Alternate
189
190
191
192 @b{Members:}
193 @table @asis
194 @item @code{i: int}
195 an integer
196 @code{b} is undocumented
197 @item @code{b: boolean}
198 Not documented
199 @end table
200
201 @b{Features:}
202 @table @asis
203 @item @code{alt-feat}
204 a feature
205 @end table
206
207 @end deftp
208
209
210 @subsection Another subsection
211
212
213 @deftypefn Command {} cmd
214
215
216
217 @b{Arguments:}
218 @table @asis
219 @item @code{arg1: int}
220 the first argument
221 @item @code{arg2: string} (optional)
222 the second
223 argument
224 @item @code{arg3: boolean}
225 Not documented
226 @end table
227
228 @b{Features:}
229 @table @asis
230 @item @code{cmd-feat1}
231 a feature
232 @item @code{cmd-feat2}
233 another feature
234 @end table
235
236 @b{Note:}
237 @code{arg3} is undocumented
238
239 @b{Returns:}
240 @code{Object}
241
242 @b{TODO:}
243 frobnicate
244
245 @b{Notes:}
246 @itemize @minus
247 @item
248 Lorem ipsum dolor sit amet
249 @item
250 Ut enim ad minim veniam
251
252 @end itemize
253
254 Duis aute irure dolor
255
256 @b{Example:}
257 @example
258 -> in
259 <- out
260 @end example
261
262 @b{Examples:}
263 @example
264 - *verbatim*
265 - @{braces@}
266 @end example
267
268 @b{Since:}
269 2.10
270
271 @end deftypefn
272
273
274
275 @deftypefn Command {} cmd-boxed
276
277 If you're bored enough to read this, go see a video of boxed cats
278
279 @b{Arguments:} the members of @code{Object}
280
281 @b{Features:}
282 @table @asis
283 @item @code{cmd-feat1}
284 a feature
285 @item @code{cmd-feat2}
286 another feature
287 @end table
288
289 @b{Example:}
290 @example
291 -> in
292
293 <- out
294 @end example
295
296 @end deftypefn
297
298
299
300 @deftypefn Event {} EVT-BOXED
301
302
303
304 @b{Arguments:} the members of @code{Object}
305
306 @b{Features:}
307 @table @asis
308 @item @code{feat3}
309 a feature
310 @end table
311
312 @end deftypefn
313