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