tests/qapi-schema/doc-good.out

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