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