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: **"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 "enum-member-feat"
  60    a member feature
  61
  62 "two" is undocumented
  63
  64
  65 If
  66 ~~
  67
  68 "IFCOND"
  69
  70
  71 "Base" (Object)
  72 ---------------
  73
  74
  75 Members
  76 ~~~~~~~
  77
  78 "base1": "Enum"
  79    the first member
  80
  81
  82 If
  83 ~~
  84
  85 "IFALL1 and IFALL2"
  86
  87
  88 "Variant1" (Object)
  89 -------------------
  90
  91 A paragraph
  92
  93 Another paragraph (but no "var": line)
  94
  95
  96 Members
  97 ~~~~~~~
  98
  99 "var1": "string" (**If: **"IFSTR")
 100    Not documented
 101
 102
 103 Features
 104 ~~~~~~~~
 105
 106 "variant1-feat"
 107    a feature
 108
 109 "member-feat"
 110    a member feature
 111
 112
 113 "Variant2" (Object)
 114 -------------------
 115
 116
 117 "Object" (Object)
 118 -----------------
 119
 120
 121 Members
 122 ~~~~~~~
 123
 124 The members of "Base"
 125 The members of "Variant1" when "base1" is ""one""
 126 The members of "Variant2" when "base1" is ""two"" (**If: **"IFONE or
 127 IFTWO")
 128
 129 Features
 130 ~~~~~~~~
 131
 132 "union-feat1"
 133    a feature
 134
 135
 136 "Alternate" (Alternate)
 137 -----------------------
 138
 139
 140 Members
 141 ~~~~~~~
 142
 143 "i": "int"
 144    an integer "b" is undocumented
 145
 146 "b": "boolean"
 147    Not documented
 148
 149
 150 Features
 151 ~~~~~~~~
 152
 153 "alt-feat"
 154    a feature
 155
 156
 157 If
 158 ~~
 159
 160 "not (IFONE or IFTWO)"
 161
 162
 163 Another subsection
 164 ==================
 165
 166
 167 "cmd" (Command)
 168 ---------------
 169
 170
 171 Arguments
 172 ~~~~~~~~~
 173
 174 "arg1": "int"
 175    the first argument
 176
 177 "arg2": "string" (optional)
 178    the second argument
 179
 180 "arg3": "boolean"
 181    Not documented
 182
 183
 184 Features
 185 ~~~~~~~~
 186
 187 "cmd-feat1"
 188    a feature
 189
 190 "cmd-feat2"
 191    another feature
 192
 193
 194 Note
 195 ~~~~
 196
 197 "arg3" is undocumented
 198
 199
 200 Returns
 201 ~~~~~~~
 202
 203 "Object"
 204
 205
 206 TODO
 207 ~~~~
 208
 209 frobnicate
 210
 211
 212 Notes
 213 ~~~~~
 214
 215 * Lorem ipsum dolor sit amet
 216
 217 * Ut enim ad minim veniam
 218
 219 Duis aute irure dolor
 220
 221
 222 Example
 223 ~~~~~~~
 224
 225    -> in
 226    <- out
 227
 228
 229 Examples
 230 ~~~~~~~~
 231
 232    - *verbatim*
 233    - {braces}
 234
 235
 236 Since
 237 ~~~~~
 238
 239 2.10
 240
 241
 242 "cmd-boxed" (Command)
 243 ---------------------
 244
 245 If you're bored enough to read this, go see a video of boxed cats
 246
 247
 248 Arguments
 249 ~~~~~~~~~
 250
 251 The members of "Object"
 252
 253 Features
 254 ~~~~~~~~
 255
 256 "cmd-feat1"
 257    a feature
 258
 259 "cmd-feat2"
 260    another feature
 261
 262
 263 Example
 264 ~~~~~~~
 265
 266    -> in
 267
 268    <- out
 269
 270
 271 "EVT_BOXED" (Event)
 272 -------------------
 273
 274
 275 Arguments
 276 ~~~~~~~~~
 277
 278 The members of "Object"
 279
 280 Features
 281 ~~~~~~~~
 282
 283 "feat3"
 284    a feature