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