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