xref: /openbmc/qemu/tests/qapi-schema/doc-good.txt (revision 5d83b9a130690f879d5f33e991beabe69cb88bc8)
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: **"defined(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"defined(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: **"defined(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: **"IFTWO")
124
125Features
126~~~~~~~~
127
128"union-feat1"
129   a feature
130
131
132"SugaredUnion" (Object)
133-----------------------
134
135
136Members
137~~~~~~~
138
139"type"
140   One of "one", "two"
141
142"data": "Variant1" when "type" is ""one""
143"data": "Variant2" when "type" is ""two"" (**If: **"IFTWO")
144
145Features
146~~~~~~~~
147
148"union-feat2"
149   a feature
150
151
152"Alternate" (Alternate)
153-----------------------
154
155
156Members
157~~~~~~~
158
159"i": "int"
160   an integer "b" is undocumented
161
162"b": "boolean"
163   Not documented
164
165
166Features
167~~~~~~~~
168
169"alt-feat"
170   a feature
171
172
173Another subsection
174==================
175
176
177"cmd" (Command)
178---------------
179
180
181Arguments
182~~~~~~~~~
183
184"arg1": "int"
185   the first argument
186
187"arg2": "string" (optional)
188   the second argument
189
190"arg3": "boolean"
191   Not documented
192
193
194Features
195~~~~~~~~
196
197"cmd-feat1"
198   a feature
199
200"cmd-feat2"
201   another feature
202
203
204Note
205~~~~
206
207"arg3" is undocumented
208
209
210Returns
211~~~~~~~
212
213"Object"
214
215
216TODO
217~~~~
218
219frobnicate
220
221
222Notes
223~~~~~
224
225* Lorem ipsum dolor sit amet
226
227* Ut enim ad minim veniam
228
229Duis aute irure dolor
230
231
232Example
233~~~~~~~
234
235   -> in
236   <- out
237
238
239Examples
240~~~~~~~~
241
242   - *verbatim*
243   - {braces}
244
245
246Since
247~~~~~
248
2492.10
250
251
252"cmd-boxed" (Command)
253---------------------
254
255If you're bored enough to read this, go see a video of boxed cats
256
257
258Arguments
259~~~~~~~~~
260
261The members of "Object"
262
263Features
264~~~~~~~~
265
266"cmd-feat1"
267   a feature
268
269"cmd-feat2"
270   another feature
271
272
273Example
274~~~~~~~
275
276   -> in
277
278   <- out
279
280
281"EVT_BOXED" (Event)
282-------------------
283
284
285Arguments
286~~~~~~~~~
287
288The members of "Object"
289
290Features
291~~~~~~~~
292
293"feat3"
294   a feature
295