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