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