tests/qapi-schema/doc-good.out

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