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