xref: /openbmc/qemu/tests/qapi-schema/doc-good.out (revision 013b4efc9be9af8276bd891cd52267d409f1d712)
1module None
2object q_empty
3enum QType
4    prefix QTYPE
5    member none
6    member qnull
7    member qnum
8    member qstring
9    member qdict
10    member qlist
11    member qbool
12module doc-good.json
13enum Enum
14    member one
15        if ['defined(IFONE)']
16    member two
17    if ['defined(IFCOND)']
18    feature enum-feat
19object Base
20    member base1: Enum optional=False
21object Variant1
22    member var1: str optional=False
23        if ['defined(IFSTR)']
24    feature variant1-feat
25object Variant2
26object Object
27    base Base
28    tag base1
29    case one: Variant1
30    case two: Variant2
31        if ['IFTWO']
32    feature union-feat1
33object q_obj_Variant1-wrapper
34    member data: Variant1 optional=False
35object q_obj_Variant2-wrapper
36    member data: Variant2 optional=False
37enum SugaredUnionKind
38    member one
39    member two
40        if ['IFTWO']
41object SugaredUnion
42    member type: SugaredUnionKind optional=False
43    tag type
44    case one: q_obj_Variant1-wrapper
45    case two: q_obj_Variant2-wrapper
46        if ['IFTWO']
47    feature union-feat2
48alternate Alternate
49    tag type
50    case i: int
51    case b: bool
52    feature alt-feat
53object q_obj_cmd-arg
54    member arg1: int optional=False
55    member arg2: str optional=True
56    member arg3: bool optional=False
57command cmd q_obj_cmd-arg -> Object
58    gen=True success_response=True boxed=False oob=False preconfig=False
59    feature cmd-feat1
60    feature cmd-feat2
61command cmd-boxed Object -> None
62    gen=True success_response=True boxed=True oob=False preconfig=False
63    feature cmd-feat1
64    feature cmd-feat2
65event EVT-BOXED Object
66    boxed=True
67    feature feat3
68doc freeform
69    body=
70= Section
71
72== Subsection
73
74*strong* _with emphasis_
75@var {in braces}
76* List item one
77- Two, multiple
78lines
79
803. Three
81Still in list
82
83Not in list
84- Second list
85Note: still in list
86
87Note: not in list
881. Third list
89is numbered
90
91- another item
92
93| example
94| multiple lines
95
96Returns: the King
97Since: the first age
98Notes:
99
1001. Lorem ipsum dolor sit amet
101
1022. Ut enim ad minim veniam
103
104Duis aute irure dolor
105
106Example:
107
108-> in
109<- out
110Examples:
111- *verbatim*
112- {braces}
113doc symbol=Enum
114    body=
115
116    arg=one
117The _one_ {and only}
118    arg=two
119
120    feature=enum-feat
121Also _one_ {and only}
122    section=None
123@two is undocumented
124doc symbol=Base
125    body=
126
127    arg=base1
128the first member
129doc symbol=Variant1
130    body=
131A paragraph
132
133Another paragraph (but no @var: line)
134    arg=var1
135
136    feature=variant1-feat
137a feature
138doc symbol=Variant2
139    body=
140
141doc symbol=Object
142    body=
143
144    feature=union-feat1
145a feature
146doc symbol=SugaredUnion
147    body=
148
149    arg=type
150
151    feature=union-feat2
152a feature
153doc symbol=Alternate
154    body=
155
156    arg=i
157an integer
158@b is undocumented
159    arg=b
160
161    feature=alt-feat
162a feature
163doc freeform
164    body=
165== Another subsection
166doc symbol=cmd
167    body=
168
169    arg=arg1
170the first argument
171    arg=arg2
172the second
173argument
174    arg=arg3
175
176    feature=cmd-feat1
177a feature
178    feature=cmd-feat2
179another feature
180    section=Note
181@arg3 is undocumented
182    section=Returns
183@Object
184    section=TODO
185frobnicate
186    section=Notes
187- Lorem ipsum dolor sit amet
188- Ut enim ad minim veniam
189
190Duis aute irure dolor
191    section=Example
192-> in
193<- out
194    section=Examples
195- *verbatim*
196- {braces}
197    section=Since
1982.10
199doc symbol=cmd-boxed
200    body=
201If you're bored enough to read this, go see a video of boxed cats
202    feature=cmd-feat1
203a feature
204    feature=cmd-feat2
205another feature
206    section=Example
207-> in
208
209<- out
210doc symbol=EVT-BOXED
211    body=
212
213    feature=feat3
214a feature
215