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