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