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