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