tests/qapi-schema/doc-good.out

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