tests/qapi-schema/doc-good.txt

   1 Section
   2 *******
   3
   4
   5 Subsection
   6 ==========
   7
   8 *with emphasis* "var" {in braces}
   9
  10 * List item one
  11
  12 * Two, multiple lines
  13
  14 * Three Still in list
  15
  16 Not in list
  17
  18 * Second list Note: still in list
  19
  20 Note: not in list
  21
  22 1. Third list is numbered
  23
  24 2. another item
  25
  26 Returns: the King Since: the first age Notes:
  27
  28 1. Lorem ipsum dolor sit amet
  29
  30 2. Ut enim ad minim veniam
  31
  32 Duis aute irure dolor
  33
  34 Example:
  35
  36 -> in <- out Examples: - *verbatim* - {braces}
  37
  38
  39 "Enum" (Enum)
  40 -------------
  41
  42
  43 Values
  44 ~~~~~~
  45
  46 "one" (**If: **"defined(IFONE)")
  47    The _one_ {and only}
  48
  49 "two"
  50    Not documented
  51
  52
  53 Features
  54 ~~~~~~~~
  55
  56 "enum-feat"
  57    Also _one_ {and only}
  58
  59 "two" is undocumented
  60
  61
  62 If
  63 ~~
  64
  65 "defined(IFCOND)"
  66
  67
  68 "Base" (Object)
  69 ---------------
  70
  71
  72 Members
  73 ~~~~~~~
  74
  75 "base1": "Enum"
  76    the first member
  77
  78
  79 "Variant1" (Object)
  80 -------------------
  81
  82 A paragraph
  83
  84 Another paragraph (but no "var": line)
  85
  86
  87 Members
  88 ~~~~~~~
  89
  90 "var1": "string" (**If: **"defined(IFSTR)")
  91    Not documented
  92
  93
  94 Features
  95 ~~~~~~~~
  96
  97 "variant1-feat"
  98    a feature
  99
 100 "member-feat"
 101    a member feature
 102
 103
 104 "Variant2" (Object)
 105 -------------------
 106
 107
 108 "Object" (Object)
 109 -----------------
 110
 111
 112 Members
 113 ~~~~~~~
 114
 115 The members of "Base"
 116 The members of "Variant1" when "base1" is ""one""
 117 The members of "Variant2" when "base1" is ""two"" (**If: **"IFTWO")
 118
 119 Features
 120 ~~~~~~~~
 121
 122 "union-feat1"
 123    a feature
 124
 125
 126 "SugaredUnion" (Object)
 127 -----------------------
 128
 129
 130 Members
 131 ~~~~~~~
 132
 133 "type"
 134    One of "one", "two"
 135
 136 "data": "Variant1" when "type" is ""one""
 137 "data": "Variant2" when "type" is ""two"" (**If: **"IFTWO")
 138
 139 Features
 140 ~~~~~~~~
 141
 142 "union-feat2"
 143    a feature
 144
 145
 146 "Alternate" (Alternate)
 147 -----------------------
 148
 149
 150 Members
 151 ~~~~~~~
 152
 153 "i": "int"
 154    an integer "b" is undocumented
 155
 156 "b": "boolean"
 157    Not documented
 158
 159
 160 Features
 161 ~~~~~~~~
 162
 163 "alt-feat"
 164    a feature
 165
 166
 167 Another subsection
 168 ==================
 169
 170
 171 "cmd" (Command)
 172 ---------------
 173
 174
 175 Arguments
 176 ~~~~~~~~~
 177
 178 "arg1": "int"
 179    the first argument
 180
 181 "arg2": "string" (optional)
 182    the second argument
 183
 184 "arg3": "boolean"
 185    Not documented
 186
 187
 188 Features
 189 ~~~~~~~~
 190
 191 "cmd-feat1"
 192    a feature
 193
 194 "cmd-feat2"
 195    another feature
 196
 197
 198 Note
 199 ~~~~
 200
 201 "arg3" is undocumented
 202
 203
 204 Returns
 205 ~~~~~~~
 206
 207 "Object"
 208
 209
 210 TODO
 211 ~~~~
 212
 213 frobnicate
 214
 215
 216 Notes
 217 ~~~~~
 218
 219 * Lorem ipsum dolor sit amet
 220
 221 * Ut enim ad minim veniam
 222
 223 Duis aute irure dolor
 224
 225
 226 Example
 227 ~~~~~~~
 228
 229    -> in
 230    <- out
 231
 232
 233 Examples
 234 ~~~~~~~~
 235
 236    - *verbatim*
 237    - {braces}
 238
 239
 240 Since
 241 ~~~~~
 242
 243 2.10
 244
 245
 246 "cmd-boxed" (Command)
 247 ---------------------
 248
 249 If you're bored enough to read this, go see a video of boxed cats
 250
 251
 252 Arguments
 253 ~~~~~~~~~
 254
 255 The members of "Object"
 256
 257 Features
 258 ~~~~~~~~
 259
 260 "cmd-feat1"
 261    a feature
 262
 263 "cmd-feat2"
 264    another feature
 265
 266
 267 Example
 268 ~~~~~~~
 269
 270    -> in
 271
 272    <- out
 273
 274
 275 "EVT-BOXED" (Event)
 276 -------------------
 277
 278
 279 Arguments
 280 ~~~~~~~~~
 281
 282 The members of "Object"
 283
 284 Features
 285 ~~~~~~~~
 286
 287 "feat3"
 288    a feature