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