tests/qapi-schema/doc-good.out

   1 module ./builtin
   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     feature enum-feat
  19 object Base
  20     member base1: Enum optional=False
  21     if OrderedDict([('all', ['IFALL1', 'IFALL2'])])
  22 object Variant1
  23     member var1: str optional=False
  24         if defined(IFSTR)
  25         feature member-feat
  26     feature variant1-feat
  27 object Variant2
  28 object Object
  29     base Base
  30     tag base1
  31     case one: Variant1
  32     case two: Variant2
  33         if OrderedDict([('any', ['IFONE', 'IFTWO'])])
  34     feature union-feat1
  35 object q_obj_Variant1-wrapper
  36     member data: Variant1 optional=False
  37 object q_obj_Variant2-wrapper
  38     member data: Variant2 optional=False
  39 enum SugaredUnionKind
  40     member one
  41     member two
  42         if IFTWO
  43 object SugaredUnion
  44     member type: SugaredUnionKind optional=False
  45     tag type
  46     case one: q_obj_Variant1-wrapper
  47     case two: q_obj_Variant2-wrapper
  48         if IFTWO
  49     feature union-feat2
  50 alternate Alternate
  51     tag type
  52     case i: int
  53     case b: bool
  54     feature alt-feat
  55 object q_obj_cmd-arg
  56     member arg1: int optional=False
  57     member arg2: str optional=True
  58     member arg3: bool optional=False
  59 command cmd q_obj_cmd-arg -> Object
  60     gen=True success_response=True boxed=False oob=False preconfig=False
  61     feature cmd-feat1
  62     feature cmd-feat2
  63 command cmd-boxed Object -> None
  64     gen=True success_response=True boxed=True oob=False preconfig=False
  65     feature cmd-feat1
  66     feature cmd-feat2
  67 event EVT_BOXED Object
  68     boxed=True
  69     feature feat3
  70 doc freeform
  71     body=
  72 = Section
  73 doc freeform
  74     body=
  75 == Subsection
  76
  77 *with emphasis*
  78 @var {in braces}
  79
  80 * List item one
  81 * Two, multiple
  82   lines
  83
  84 * Three
  85   Still in list
  86
  87 Not in list
  88
  89 - Second list
  90   Note: still in list
  91
  92 Note: not in list
  93
  94 1. Third list
  95    is numbered
  96
  97 2. another item
  98
  99 Returns: the King
 100 Since: the first age
 101 Notes:
 102
 103 1. Lorem ipsum dolor sit amet
 104
 105 2. Ut enim ad minim veniam
 106
 107 Duis aute irure dolor
 108
 109 Example:
 110
 111 -> in
 112 <- out
 113 Examples:
 114 - *verbatim*
 115 - {braces}
 116 doc symbol=Enum
 117     body=
 118
 119     arg=one
 120 The _one_ {and only}
 121     arg=two
 122
 123     feature=enum-feat
 124 Also _one_ {and only}
 125     section=None
 126 @two is undocumented
 127 doc symbol=Base
 128     body=
 129
 130     arg=base1
 131 the first member
 132 doc symbol=Variant1
 133     body=
 134 A paragraph
 135
 136 Another paragraph (but no @var: line)
 137     arg=var1
 138
 139     feature=variant1-feat
 140 a feature
 141     feature=member-feat
 142 a member feature
 143 doc symbol=Variant2
 144     body=
 145
 146 doc symbol=Object
 147     body=
 148
 149     feature=union-feat1
 150 a feature
 151 doc symbol=SugaredUnion
 152     body=
 153
 154     arg=type
 155
 156     feature=union-feat2
 157 a feature
 158 doc symbol=Alternate
 159     body=
 160
 161     arg=i
 162 an integer
 163 @b is undocumented
 164     arg=b
 165
 166     feature=alt-feat
 167 a feature
 168 doc freeform
 169     body=
 170 == Another subsection
 171 doc symbol=cmd
 172     body=
 173
 174     arg=arg1
 175 the first argument
 176     arg=arg2
 177 the second
 178 argument
 179     arg=arg3
 180
 181     feature=cmd-feat1
 182 a feature
 183     feature=cmd-feat2
 184 another feature
 185     section=Note
 186 @arg3 is undocumented
 187     section=Returns
 188 @Object
 189     section=TODO
 190 frobnicate
 191     section=Notes
 192 - Lorem ipsum dolor sit amet
 193 - Ut enim ad minim veniam
 194
 195 Duis aute irure dolor
 196     section=Example
 197 -> in
 198 <- out
 199     section=Examples
 200 - *verbatim*
 201 - {braces}
 202     section=Since
 203 2.10
 204 doc symbol=cmd-boxed
 205     body=
 206 If you're bored enough to read this, go see a video of boxed cats
 207     feature=cmd-feat1
 208 a feature
 209     feature=cmd-feat2
 210 another feature
 211     section=Example
 212 -> in
 213
 214 <- out
 215 doc symbol=EVT_BOXED
 216     body=
 217
 218     feature=feat3
 219 a feature