xref: /openbmc/qemu/tests/qapi-schema/doc-good.txt (revision 8a156d89)
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: **"(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
174Another subsection
175==================
176
177
178"cmd" (Command)
179---------------
180
181
182Arguments
183~~~~~~~~~
184
185"arg1": "int"
186   the first argument
187
188"arg2": "string" (optional)
189   the second argument
190
191"arg3": "boolean"
192   Not documented
193
194
195Features
196~~~~~~~~
197
198"cmd-feat1"
199   a feature
200
201"cmd-feat2"
202   another feature
203
204
205Note
206~~~~
207
208"arg3" is undocumented
209
210
211Returns
212~~~~~~~
213
214"Object"
215
216
217TODO
218~~~~
219
220frobnicate
221
222
223Notes
224~~~~~
225
226* Lorem ipsum dolor sit amet
227
228* Ut enim ad minim veniam
229
230Duis aute irure dolor
231
232
233Example
234~~~~~~~
235
236   -> in
237   <- out
238
239
240Examples
241~~~~~~~~
242
243   - *verbatim*
244   - {braces}
245
246
247Since
248~~~~~
249
2502.10
251
252
253"cmd-boxed" (Command)
254---------------------
255
256If you're bored enough to read this, go see a video of boxed cats
257
258
259Arguments
260~~~~~~~~~
261
262The members of "Object"
263
264Features
265~~~~~~~~
266
267"cmd-feat1"
268   a feature
269
270"cmd-feat2"
271   another feature
272
273
274Example
275~~~~~~~
276
277   -> in
278
279   <- out
280
281
282"EVT_BOXED" (Event)
283-------------------
284
285
286Arguments
287~~~~~~~~~
288
289The members of "Object"
290
291Features
292~~~~~~~~
293
294"feat3"
295   a feature
296