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