xref: /openbmc/qemu/tests/qapi-schema/doc-good.out (revision e6e03dcf)
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']
45object q_obj_cmd-arg
46    member arg1: int optional=False
47    member arg2: str optional=True
48    member arg3: bool optional=False
49command cmd q_obj_cmd-arg -> Object
50    gen=True success_response=True boxed=False oob=False preconfig=False
51    feature cmd-feat1
52    feature cmd-feat2
53command cmd-boxed Object -> None
54    gen=True success_response=True boxed=True oob=False preconfig=False
55    feature cmd-feat1
56    feature cmd-feat2
57doc freeform
58    body=
59= Section
60
61== Subsection
62
63*strong* _with emphasis_
64@var {in braces}
65* List item one
66- Two, multiple
67lines
68
693. Three
70Still in list
71
72Not in list
73- Second list
74Note: still in list
75
76Note: not in list
771. Third list
78is numbered
79
80- another item
81
82| example
83| multiple lines
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    section=None
110@two is undocumented
111doc symbol=Base
112    body=
113
114    arg=base1
115the first member
116doc symbol=Variant1
117    body=
118A paragraph
119
120Another paragraph (but no @var: line)
121    arg=var1
122
123doc symbol=Variant2
124    body=
125
126doc symbol=Object
127    body=
128
129doc symbol=SugaredUnion
130    body=
131
132    arg=type
133
134doc freeform
135    body=
136== Another subsection
137doc symbol=cmd
138    body=
139
140    arg=arg1
141the first argument
142    arg=arg2
143the second
144argument
145    arg=arg3
146
147    section=Note
148@arg3 is undocumented
149    section=Returns
150@Object
151    section=TODO
152frobnicate
153    section=Notes
154- Lorem ipsum dolor sit amet
155- Ut enim ad minim veniam
156
157Duis aute irure dolor
158    section=Example
159-> in
160<- out
161    section=Examples
162- *verbatim*
163- {braces}
164    section=Since
1652.10
166doc symbol=cmd-boxed
167    body=
168If you're bored enough to read this, go see a video of boxed cats
169    section=Example
170-> in
171
172<- out
173