xref: /qemu/tests/qapi-schema/doc-good.out (revision c5955f4f)
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}
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
120the first member
121doc symbol=Variant1
122    body=
123A paragraph
124
125Another paragraph (but no @var: line)
126    arg=var1
127
128    feature=variant1-feat
129a feature
130    feature=member-feat
131a member feature
132doc symbol=Variant2
133    body=
134
135doc symbol=Object
136    body=
137
138    feature=union-feat1
139a feature
140doc symbol=Alternate
141    body=
142
143    arg=i
144an integer
145@b is undocumented
146    arg=b
147
148    feature=alt-feat
149a feature
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    feature=feat3
201a feature
202