tests/qapi-schema/doc-good.out

   1 module ./builtin
   2 object q_empty
   3 enum QType
   4     member none
   5     member qnull
   6     member qnum
   7     member qstring
   8     member qdict
   9     member qlist
  10     member qbool
  11 module doc-good.json
  12 enum Enum
  13     member one
  14         if IFONE
  15         feature enum-member-feat
  16     member two
  17     if IFCOND
  18     feature enum-feat
  19 object Base
  20     member base1: Enum optional=False
  21     if {'all': ['IFALL1', 'IFALL2']}
  22 object Variant1
  23     member var1: str optional=False
  24         if 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 {'any': ['IFONE', 'IFTWO']}
  34     feature union-feat1
  35 alternate Alternate
  36     tag type
  37     case i: int
  38     case b: bool
  39     if {'not': {'any': ['IFONE', 'IFTWO']}}
  40     feature alt-feat
  41 object q_obj_cmd-arg
  42     member arg1: int optional=False
  43     member arg2: str optional=True
  44     member arg3: bool optional=False
  45 command cmd q_obj_cmd-arg -> Object
  46     gen=True success_response=True boxed=False oob=False preconfig=False
  47     feature cmd-feat1
  48     feature cmd-feat2
  49 command cmd-boxed Object -> None
  50     gen=True success_response=True boxed=True oob=False preconfig=False
  51     feature cmd-feat1
  52     feature cmd-feat2
  53 event EVT_BOXED Object
  54     boxed=True
  55     feature feat3
  56 doc freeform
  57     body=
  58 = Section
  59 doc freeform
  60     body=
  61 == Subsection
  62
  63 *with emphasis*
  64 @var {in braces}
  65
  66 * List item one
  67 * Two, multiple
  68   lines
  69
  70 * Three
  71   Still in list
  72
  73 Not in list
  74
  75 - Second list
  76   Note: still in list
  77
  78 Note: not in list
  79
  80 1. Third list
  81    is numbered
  82
  83 2. another item
  84
  85 Returns: the King
  86 Since: the first age
  87 Notes:
  88
  89 1. Lorem ipsum dolor sit amet
  90
  91 2. Ut enim ad minim veniam
  92
  93 Duis aute irure dolor
  94
  95 Example:
  96
  97 -> in
  98 <- out
  99 Examples:
 100 - *verbatim*
 101 - {braces}
 102 doc symbol=Enum
 103     body=
 104
 105     arg=one
 106 The _one_ {and only}, description on the same line
 107     arg=two
 108
 109     feature=enum-feat
 110 Also _one_ {and only}
 111     feature=enum-member-feat
 112 a member feature
 113     section=None
 114 @two is undocumented
 115 doc symbol=Base
 116     body=
 117
 118     arg=base1
 119  description starts on a new line,
 120  minimally indented
 121 doc symbol=Variant1
 122     body=
 123 A paragraph
 124
 125 Another paragraph
 126
 127 @var1 is undocumented
 128     arg=var1
 129
 130     feature=variant1-feat
 131 a feature
 132     feature=member-feat
 133 a member feature
 134 doc symbol=Variant2
 135     body=
 136
 137 doc symbol=Object
 138     body=
 139
 140     feature=union-feat1
 141 a feature
 142 doc symbol=Alternate
 143     body=
 144
 145     arg=i
 146 description starts on the same line
 147     remainder indented the same
 148     @b is undocumented
 149     arg=b
 150
 151     feature=alt-feat
 152 a feature
 153 doc freeform
 154     body=
 155 == Another subsection
 156 doc symbol=cmd
 157     body=
 158
 159     arg=arg1
 160     description starts on a new line,
 161     indented
 162     arg=arg2
 163 description starts on the same line
 164     remainder indented differently
 165     arg=arg3
 166
 167     feature=cmd-feat1
 168 a feature
 169     feature=cmd-feat2
 170 another feature
 171     section=None
 172 .. note:: @arg3 is undocumented
 173     section=Returns
 174 @Object
 175     section=Errors
 176 some
 177     section=TODO
 178 frobnicate
 179     section=None
 180 .. admonition:: Notes
 181
 182  - Lorem ipsum dolor sit amet
 183  - Ut enim ad minim veniam
 184
 185  Duis aute irure dolor
 186
 187 .. qmp-example::
 188    :title: Ideal fast-food burger situation
 189
 190    -> "in"
 191    <- "out"
 192
 193 Examples::
 194
 195  - Not a QMP code block
 196  - Merely a preformatted code block literal
 197  It isn't even an rST list.
 198  - *verbatim*
 199  - {braces}
 200
 201 Note::
 202     Ceci n'est pas une note
 203     section=Since
 204 2.10
 205 doc symbol=cmd-boxed
 206     body=
 207 If you're bored enough to read this, go see a video of boxed cats
 208     feature=cmd-feat1
 209 a feature
 210     feature=cmd-feat2
 211 another feature
 212     section=None
 213 .. qmp-example::
 214
 215    -> "this example"
 216
 217    <- "has no title"
 218 doc symbol=EVT_BOXED
 219     body=
 220
 221     feature=feat3
 222 a feature