xref: /openbmc/qemu/tests/qapi-schema/doc-good.out (revision 8a156d89)
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 defined(IFONE)
16    member two
17    if defined(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 defined(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    feature alt-feat
55object q_obj_cmd-arg
56    member arg1: int optional=False
57    member arg2: str optional=True
58    member arg3: bool optional=False
59command cmd q_obj_cmd-arg -> Object
60    gen=True success_response=True boxed=False oob=False preconfig=False
61    feature cmd-feat1
62    feature cmd-feat2
63command cmd-boxed Object -> None
64    gen=True success_response=True boxed=True oob=False preconfig=False
65    feature cmd-feat1
66    feature cmd-feat2
67event EVT_BOXED Object
68    boxed=True
69    feature feat3
70doc freeform
71    body=
72= Section
73doc freeform
74    body=
75== Subsection
76
77*with emphasis*
78@var {in braces}
79
80* List item one
81* Two, multiple
82  lines
83
84* Three
85  Still in list
86
87Not in list
88
89- Second list
90  Note: still in list
91
92Note: not in list
93
941. Third list
95   is numbered
96
972. another item
98
99Returns: the King
100Since: the first age
101Notes:
102
1031. Lorem ipsum dolor sit amet
104
1052. Ut enim ad minim veniam
106
107Duis aute irure dolor
108
109Example:
110
111-> in
112<- out
113Examples:
114- *verbatim*
115- {braces}
116doc symbol=Enum
117    body=
118
119    arg=one
120The _one_ {and only}
121    arg=two
122
123    feature=enum-feat
124Also _one_ {and only}
125    section=None
126@two is undocumented
127doc symbol=Base
128    body=
129
130    arg=base1
131the first member
132doc symbol=Variant1
133    body=
134A paragraph
135
136Another paragraph (but no @var: line)
137    arg=var1
138
139    feature=variant1-feat
140a feature
141    feature=member-feat
142a member feature
143doc symbol=Variant2
144    body=
145
146doc symbol=Object
147    body=
148
149    feature=union-feat1
150a feature
151doc symbol=SugaredUnion
152    body=
153
154    arg=type
155
156    feature=union-feat2
157a feature
158doc symbol=Alternate
159    body=
160
161    arg=i
162an integer
163@b is undocumented
164    arg=b
165
166    feature=alt-feat
167a feature
168doc freeform
169    body=
170== Another subsection
171doc symbol=cmd
172    body=
173
174    arg=arg1
175the first argument
176    arg=arg2
177the second
178argument
179    arg=arg3
180
181    feature=cmd-feat1
182a feature
183    feature=cmd-feat2
184another feature
185    section=Note
186@arg3 is undocumented
187    section=Returns
188@Object
189    section=TODO
190frobnicate
191    section=Notes
192- Lorem ipsum dolor sit amet
193- Ut enim ad minim veniam
194
195Duis aute irure dolor
196    section=Example
197-> in
198<- out
199    section=Examples
200- *verbatim*
201- {braces}
202    section=Since
2032.10
204doc symbol=cmd-boxed
205    body=
206If you're bored enough to read this, go see a video of boxed cats
207    feature=cmd-feat1
208a feature
209    feature=cmd-feat2
210another feature
211    section=Example
212-> in
213
214<- out
215doc symbol=EVT_BOXED
216    body=
217
218    feature=feat3
219a feature
220