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