xref: /openbmc/qemu/tests/qapi-schema/doc-good.out (revision a35c9bf82aff4e80a90f0adfc7383d03749db0b6)
1object q_empty
2enum QType
3    prefix QTYPE
4    member none
5    member qnull
6    member qnum
7    member qstring
8    member qdict
9    member qlist
10    member qbool
11module doc-good.json
12enum Enum
13    member one
14        if ['defined(IFONE)']
15    member two
16    if ['defined(IFCOND)']
17object Base
18    member base1: Enum optional=False
19object Variant1
20    member var1: str optional=False
21object Variant2
22object Object
23    base Base
24    tag base1
25    case one: Variant1
26    case two: Variant2
27object q_obj_Variant1-wrapper
28    member data: Variant1 optional=False
29object q_obj_Variant2-wrapper
30    member data: Variant2 optional=False
31enum SugaredUnionKind
32    member one
33    member two
34object SugaredUnion
35    member type: SugaredUnionKind optional=False
36    tag type
37    case one: q_obj_Variant1-wrapper
38    case two: q_obj_Variant2-wrapper
39object q_obj_cmd-arg
40    member arg1: int optional=False
41    member arg2: str optional=True
42    member arg3: bool optional=False
43command cmd q_obj_cmd-arg -> Object
44   gen=True success_response=True boxed=False oob=False preconfig=False
45command cmd-boxed Object -> None
46   gen=True success_response=True boxed=True oob=False preconfig=False
47doc freeform
48    body=
49= Section
50
51== Subsection
52
53*strong* _with emphasis_
54@var {in braces}
55* List item one
56- Two, multiple
57lines
58
593. Three
60Still in list
61
62Not in list
63- Second list
64Note: still in list
65
66Note: not in list
671. Third list
68is numbered
69
70- another item
71
72| example
73| multiple lines
74
75Returns: the King
76Since: the first age
77Notes:
78
791. Lorem ipsum dolor sit amet
80
812. Ut enim ad minim veniam
82
83Duis aute irure dolor
84
85Example:
86
87-> in
88<- out
89Examples:
90- *verbatim*
91- {braces}
92doc symbol=Enum
93    body=
94
95    arg=one
96The _one_ {and only}
97    arg=two
98
99    section=None
100@two is undocumented
101doc symbol=Base
102    body=
103
104    arg=base1
105the first member
106doc symbol=Variant1
107    body=
108A paragraph
109
110Another paragraph (but no @var: line)
111    arg=var1
112
113doc symbol=Variant2
114    body=
115
116doc symbol=Object
117    body=
118
119doc symbol=SugaredUnion
120    body=
121
122    arg=type
123
124doc freeform
125    body=
126== Another subsection
127doc symbol=cmd
128    body=
129
130    arg=arg1
131the first argument
132    arg=arg2
133the second
134argument
135    arg=arg3
136
137    section=Note
138@arg3 is undocumented
139    section=Returns
140@Object
141    section=TODO
142frobnicate
143    section=Notes
144- Lorem ipsum dolor sit amet
145- Ut enim ad minim veniam
146
147Duis aute irure dolor
148    section=Example
149-> in
150<- out
151    section=Examples
152- *verbatim*
153- {braces}
154    section=Since
1552.10
156doc symbol=cmd-boxed
157    body=
158If you're bored enough to read this, go see a video of boxed cats
159    section=Example
160-> in
161
162<- out
163