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