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 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 doc freeform
  73     body=
  74 == Subsection
  75
  76 *with emphasis*
  77 @var {in braces}
  78
  79 * List item one
  80 * Two, multiple
  81   lines
  82
  83 * Three
  84   Still in list
  85
  86 Not in list
  87
  88 - Second list
  89   Note: still in list
  90
  91 Note: not in list
  92
  93 1. Third list
  94    is numbered
  95
  96 2. another item
  97
  98 Returns: the King
  99 Since: the first age
 100 Notes:
 101
 102 1. Lorem ipsum dolor sit amet
 103
 104 2. Ut enim ad minim veniam
 105
 106 Duis aute irure dolor
 107
 108 Example:
 109
 110 -> in
 111 <- out
 112 Examples:
 113 - *verbatim*
 114 - {braces}
 115 doc symbol=Enum
 116     body=
 117
 118     arg=one
 119 The _one_ {and only}
 120     arg=two
 121
 122     feature=enum-feat
 123 Also _one_ {and only}
 124     section=None
 125 @two is undocumented
 126 doc symbol=Base
 127     body=
 128
 129     arg=base1
 130 the first member
 131 doc symbol=Variant1
 132     body=
 133 A paragraph
 134
 135 Another paragraph (but no @var: line)
 136     arg=var1
 137
 138     feature=variant1-feat
 139 a feature
 140     feature=member-feat
 141 a member feature
 142 doc symbol=Variant2
 143     body=
 144
 145 doc symbol=Object
 146     body=
 147
 148     feature=union-feat1
 149 a feature
 150 doc symbol=SugaredUnion
 151     body=
 152
 153     arg=type
 154
 155     feature=union-feat2
 156 a feature
 157 doc symbol=Alternate
 158     body=
 159
 160     arg=i
 161 an integer
 162 @b is undocumented
 163     arg=b
 164
 165     feature=alt-feat
 166 a feature
 167 doc freeform
 168     body=
 169 == Another subsection
 170 doc symbol=cmd
 171     body=
 172
 173     arg=arg1
 174 the first argument
 175     arg=arg2
 176 the second
 177 argument
 178     arg=arg3
 179
 180     feature=cmd-feat1
 181 a feature
 182     feature=cmd-feat2
 183 another feature
 184     section=Note
 185 @arg3 is undocumented
 186     section=Returns
 187 @Object
 188     section=TODO
 189 frobnicate
 190     section=Notes
 191 - Lorem ipsum dolor sit amet
 192 - Ut enim ad minim veniam
 193
 194 Duis aute irure dolor
 195     section=Example
 196 -> in
 197 <- out
 198     section=Examples
 199 - *verbatim*
 200 - {braces}
 201     section=Since
 202 2.10
 203 doc symbol=cmd-boxed
 204     body=
 205 If you're bored enough to read this, go see a video of boxed cats
 206     feature=cmd-feat1
 207 a feature
 208     feature=cmd-feat2
 209 another feature
 210     section=Example
 211 -> in
 212
 213 <- out
 214 doc symbol=EVT-BOXED
 215     body=
 216
 217     feature=feat3
 218 a feature