xref: /qemu/tests/qapi-schema/doc-good.out (revision 901a34a400a0dd5bf5056b6b9ecce48ab8eb02ac)
18a84767cSMarkus Armbrusterobject q_empty
28a84767cSMarkus Armbrusterenum QType ['none', 'qnull', 'qnum', 'qstring', 'qdict', 'qlist', 'qbool']
38a84767cSMarkus Armbruster    prefix QTYPE
4cf40a0a5SMarkus Armbrustermodule doc-good.json
58a84767cSMarkus Armbrusterenum Enum ['one', 'two']
6*901a34a4SMarc-André Lureau    if ['defined(IFCOND)']
780d1f2e4SMarkus Armbrusterobject Base
880d1f2e4SMarkus Armbruster    member base1: Enum optional=False
98a84767cSMarkus Armbrusterobject Variant1
108a84767cSMarkus Armbruster    member var1: str optional=False
118a84767cSMarkus Armbrusterobject Variant2
1280d1f2e4SMarkus Armbrusterobject Object
1380d1f2e4SMarkus Armbruster    base Base
1480d1f2e4SMarkus Armbruster    tag base1
1580d1f2e4SMarkus Armbruster    case one: Variant1
1680d1f2e4SMarkus Armbruster    case two: Variant2
178a84767cSMarkus Armbrusterobject q_obj_Variant1-wrapper
188a84767cSMarkus Armbruster    member data: Variant1 optional=False
198a84767cSMarkus Armbrusterobject q_obj_Variant2-wrapper
208a84767cSMarkus Armbruster    member data: Variant2 optional=False
218a84767cSMarkus Armbrusterenum SugaredUnionKind ['one', 'two']
2280d1f2e4SMarkus Armbrusterobject SugaredUnion
2380d1f2e4SMarkus Armbruster    member type: SugaredUnionKind optional=False
2480d1f2e4SMarkus Armbruster    tag type
2580d1f2e4SMarkus Armbruster    case one: q_obj_Variant1-wrapper
2680d1f2e4SMarkus Armbruster    case two: q_obj_Variant2-wrapper
2780d1f2e4SMarkus Armbrusterobject q_obj_cmd-arg
2880d1f2e4SMarkus Armbruster    member arg1: int optional=False
2980d1f2e4SMarkus Armbruster    member arg2: str optional=True
3080d1f2e4SMarkus Armbruster    member arg3: bool optional=False
318a84767cSMarkus Armbrustercommand cmd q_obj_cmd-arg -> Object
327b13f2c2SIgor Mammedov   gen=True success_response=True boxed=False oob=False preconfig=False
338a84767cSMarkus Armbrustercommand cmd-boxed Object -> None
347b13f2c2SIgor Mammedov   gen=True success_response=True boxed=True oob=False preconfig=False
3580d1f2e4SMarkus Armbrusterdoc freeform
3680d1f2e4SMarkus Armbruster    body=
3780d1f2e4SMarkus Armbruster= Section
3880d1f2e4SMarkus Armbruster
3980d1f2e4SMarkus Armbruster== Subsection
4080d1f2e4SMarkus Armbruster
4180d1f2e4SMarkus Armbruster*strong* _with emphasis_
4280d1f2e4SMarkus Armbruster@var {in braces}
4380d1f2e4SMarkus Armbruster* List item one
4480d1f2e4SMarkus Armbruster- Two, multiple
4580d1f2e4SMarkus Armbrusterlines
4680d1f2e4SMarkus Armbruster
4780d1f2e4SMarkus Armbruster3. Three
4880d1f2e4SMarkus ArmbrusterStill in list
4980d1f2e4SMarkus Armbruster
5080d1f2e4SMarkus ArmbrusterNot in list
5180d1f2e4SMarkus Armbruster- Second list
5280d1f2e4SMarkus ArmbrusterNote: still in list
5380d1f2e4SMarkus Armbruster
5480d1f2e4SMarkus ArmbrusterNote: not in list
5580d1f2e4SMarkus Armbruster1. Third list
5680d1f2e4SMarkus Armbrusteris numbered
5780d1f2e4SMarkus Armbruster
5880d1f2e4SMarkus Armbruster- another item
5980d1f2e4SMarkus Armbruster
6080d1f2e4SMarkus Armbruster| example
6180d1f2e4SMarkus Armbruster| multiple lines
6280d1f2e4SMarkus Armbruster
6380d1f2e4SMarkus ArmbrusterReturns: the King
6480d1f2e4SMarkus ArmbrusterSince: the first age
6580d1f2e4SMarkus ArmbrusterNotes:
6680d1f2e4SMarkus Armbruster
6780d1f2e4SMarkus Armbruster1. Lorem ipsum dolor sit amet
6880d1f2e4SMarkus Armbruster
6980d1f2e4SMarkus Armbruster2. Ut enim ad minim veniam
7080d1f2e4SMarkus Armbruster
7180d1f2e4SMarkus ArmbrusterDuis aute irure dolor
7280d1f2e4SMarkus Armbruster
7380d1f2e4SMarkus ArmbrusterExample:
7480d1f2e4SMarkus Armbruster
7580d1f2e4SMarkus Armbruster-> in
7680d1f2e4SMarkus Armbruster<- out
7780d1f2e4SMarkus ArmbrusterExamples:
7880d1f2e4SMarkus Armbruster- *verbatim*
7980d1f2e4SMarkus Armbruster- {braces}
8080d1f2e4SMarkus Armbrusterdoc symbol=Enum
8180d1f2e4SMarkus Armbruster    body=
82cfa438ffSMarkus Armbruster
8380d1f2e4SMarkus Armbruster    arg=one
8480d1f2e4SMarkus ArmbrusterThe _one_ {and only}
8580d1f2e4SMarkus Armbruster    arg=two
8680d1f2e4SMarkus Armbruster
87fc3f0df1SMarkus Armbruster    section=None
8880d1f2e4SMarkus Armbruster@two is undocumented
8980d1f2e4SMarkus Armbrusterdoc symbol=Base
9080d1f2e4SMarkus Armbruster    body=
9180d1f2e4SMarkus Armbruster
9280d1f2e4SMarkus Armbruster    arg=base1
9380d1f2e4SMarkus Armbrusterthe first member
9480d1f2e4SMarkus Armbrusterdoc symbol=Variant1
9580d1f2e4SMarkus Armbruster    body=
9680d1f2e4SMarkus ArmbrusterA paragraph
9780d1f2e4SMarkus Armbruster
9880d1f2e4SMarkus ArmbrusterAnother paragraph (but no @var: line)
9980d1f2e4SMarkus Armbruster    arg=var1
10080d1f2e4SMarkus Armbruster
10180d1f2e4SMarkus Armbrusterdoc symbol=Variant2
10280d1f2e4SMarkus Armbruster    body=
10380d1f2e4SMarkus Armbruster
10480d1f2e4SMarkus Armbrusterdoc symbol=Object
10580d1f2e4SMarkus Armbruster    body=
10680d1f2e4SMarkus Armbruster
10780d1f2e4SMarkus Armbrusterdoc symbol=SugaredUnion
10880d1f2e4SMarkus Armbruster    body=
10980d1f2e4SMarkus Armbruster
11080d1f2e4SMarkus Armbruster    arg=type
11180d1f2e4SMarkus Armbruster
11280d1f2e4SMarkus Armbrusterdoc freeform
11380d1f2e4SMarkus Armbruster    body=
11480d1f2e4SMarkus Armbruster== Another subsection
11580d1f2e4SMarkus Armbrusterdoc symbol=cmd
11680d1f2e4SMarkus Armbruster    body=
11780d1f2e4SMarkus Armbruster
11880d1f2e4SMarkus Armbruster    arg=arg1
11980d1f2e4SMarkus Armbrusterthe first argument
12080d1f2e4SMarkus Armbruster    arg=arg2
12180d1f2e4SMarkus Armbrusterthe second
12280d1f2e4SMarkus Armbrusterargument
12380d1f2e4SMarkus Armbruster    arg=arg3
12480d1f2e4SMarkus Armbruster
12580d1f2e4SMarkus Armbruster    section=Note
12680d1f2e4SMarkus Armbruster@arg3 is undocumented
12780d1f2e4SMarkus Armbruster    section=Returns
12880d1f2e4SMarkus Armbruster@Object
12980d1f2e4SMarkus Armbruster    section=TODO
13080d1f2e4SMarkus Armbrusterfrobnicate
13180d1f2e4SMarkus Armbruster    section=Notes
13280d1f2e4SMarkus Armbruster- Lorem ipsum dolor sit amet
13380d1f2e4SMarkus Armbruster- Ut enim ad minim veniam
13480d1f2e4SMarkus Armbruster
13580d1f2e4SMarkus ArmbrusterDuis aute irure dolor
13680d1f2e4SMarkus Armbruster    section=Example
13780d1f2e4SMarkus Armbruster-> in
13880d1f2e4SMarkus Armbruster<- out
13980d1f2e4SMarkus Armbruster    section=Examples
14080d1f2e4SMarkus Armbruster- *verbatim*
14180d1f2e4SMarkus Armbruster- {braces}
14280d1f2e4SMarkus Armbruster    section=Since
14380d1f2e4SMarkus Armbruster2.10
14480d1f2e4SMarkus Armbrusterdoc symbol=cmd-boxed
14580d1f2e4SMarkus Armbruster    body=
14680d1f2e4SMarkus ArmbrusterIf you're bored enough to read this, go see a video of boxed cats
14780d1f2e4SMarkus Armbruster    section=Example
14880d1f2e4SMarkus Armbruster-> in
14980d1f2e4SMarkus Armbruster
15080d1f2e4SMarkus Armbruster<- out
151