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