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 object Base
  19     member base1: Enum optional=False
  20 object Variant1
  21     member var1: str optional=False
  22         if ['defined(IFSTR)']
  23     feature variant1-feat
  24 object Variant2
  25 object Object
  26     base Base
  27     tag base1
  28     case one: Variant1
  29     case two: Variant2
  30         if ['IFTWO']
  31 object q_obj_Variant1-wrapper
  32     member data: Variant1 optional=False
  33 object q_obj_Variant2-wrapper
  34     member data: Variant2 optional=False
  35 enum SugaredUnionKind
  36     member one
  37     member two
  38         if ['IFTWO']
  39 object SugaredUnion
  40     member type: SugaredUnionKind optional=False
  41     tag type
  42     case one: q_obj_Variant1-wrapper
  43     case two: q_obj_Variant2-wrapper
  44         if ['IFTWO']
  45 alternate Alternate
  46     tag type
  47     case i: int
  48     case b: bool
  49 object q_obj_cmd-arg
  50     member arg1: int optional=False
  51     member arg2: str optional=True
  52     member arg3: bool optional=False
  53 command cmd q_obj_cmd-arg -> Object
  54     gen=True success_response=True boxed=False oob=False preconfig=False
  55     feature cmd-feat1
  56     feature cmd-feat2
  57 command cmd-boxed Object -> None
  58     gen=True success_response=True boxed=True oob=False preconfig=False
  59     feature cmd-feat1
  60     feature cmd-feat2
  61 event EVT-BOXED Object
  62     boxed=True
  63 doc freeform
  64     body=
  65 = Section
  66
  67 == Subsection
  68
  69 *strong* _with emphasis_
  70 @var {in braces}
  71 * List item one
  72 - Two, multiple
  73 lines
  74
  75 3. Three
  76 Still in list
  77
  78 Not in list
  79 - Second list
  80 Note: still in list
  81
  82 Note: not in list
  83 1. Third list
  84 is numbered
  85
  86 - another item
  87
  88 | example
  89 | multiple lines
  90
  91 Returns: the King
  92 Since: the first age
  93 Notes:
  94
  95 1. Lorem ipsum dolor sit amet
  96
  97 2. Ut enim ad minim veniam
  98
  99 Duis aute irure dolor
 100
 101 Example:
 102
 103 -> in
 104 <- out
 105 Examples:
 106 - *verbatim*
 107 - {braces}
 108 doc symbol=Enum
 109     body=
 110
 111     arg=one
 112 The _one_ {and only}
 113     arg=two
 114
 115     section=None
 116 @two is undocumented
 117 doc symbol=Base
 118     body=
 119
 120     arg=base1
 121 the first member
 122 doc symbol=Variant1
 123     body=
 124 A paragraph
 125
 126 Another paragraph (but no @var: line)
 127     arg=var1
 128
 129     feature=variant1-feat
 130 a feature
 131 doc symbol=Variant2
 132     body=
 133
 134 doc symbol=Object
 135     body=
 136
 137 doc symbol=SugaredUnion
 138     body=
 139
 140     arg=type
 141
 142 doc symbol=Alternate
 143     body=
 144
 145     arg=i
 146 an integer
 147 @b is undocumented
 148     arg=b
 149
 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 BUG: generated doc misses arguments