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