tests/qapi-schema/doc-good.out

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