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