tests/qapi-schema/doc-good.texi

   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
  11 List item one
  12 @item
  13 Two, multiple
  14 lines
  15
  16 @item
  17 Three
  18 Still in list
  19
  20 @end itemize
  21
  22 Not in list
  23 @itemize @minus
  24 @item
  25 Second list
  26 Note: still in list
  27
  28 @end itemize
  29
  30 Note: not in list
  31 @enumerate
  32 @item
  33 Third list
  34 is numbered
  35
  36 @item
  37 another item
  38
  39 @example
  40 example
  41 @end example
  42
  43 @example
  44 multiple lines
  45 @end example
  46
  47
  48 @end enumerate
  49
  50 Returns: the King
  51 Since: the first age
  52 Notes:
  53
  54 @enumerate
  55 @item
  56 Lorem ipsum dolor sit amet
  57
  58 @item
  59 Ut enim ad minim veniam
  60
  61 @end enumerate
  62
  63 Duis aute irure dolor
  64
  65 Example:
  66
  67 -> in
  68 <- out
  69 Examples:
  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}
  86 The @emph{one} @{and only@}
  87 @*@b{If:} @code{defined(IFONE)}
  88 @item @code{two}
  89 Not 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}
 105 the first member
 106 @end table
 107
 108 @end deftp
 109
 110
 111
 112 @deftp {Object} Variant1
 113
 114 A paragraph
 115
 116 Another paragraph (but no @code{var}: line)
 117
 118 @b{Members:}
 119 @table @asis
 120 @item @code{var1: string}
 121 Not documented
 122 @*@b{If:} @code{defined(IFSTR)}
 123 @end table
 124
 125 @end deftp
 126
 127
 128
 129 @deftp {Object} Variant2
 130
 131
 132
 133 @end deftp
 134
 135
 136
 137 @deftp {Object} Object
 138
 139
 140
 141 @b{Members:}
 142 @table @asis
 143 @item The members of @code{Base}
 144 @item The members of @code{Variant1} when @code{base1} is @t{"one"}
 145 @item The members of @code{Variant2} when @code{base1} is @t{"two"} (@b{If:} @code{IFTWO})
 146 @end table
 147
 148 @end deftp
 149
 150
 151
 152 @deftp {Object} SugaredUnion
 153
 154
 155
 156 @b{Members:}
 157 @table @asis
 158 @item @code{type}
 159 One of @t{"one"}, @t{"two"}
 160 @item @code{data: Variant1} when @code{type} is @t{"one"}
 161 @item @code{data: Variant2} when @code{type} is @t{"two"} (@b{If:} @code{IFTWO})
 162 @end table
 163
 164 @end deftp
 165
 166
 167 @subsection Another subsection
 168
 169
 170 @deftypefn Command {} cmd
 171
 172
 173
 174 @b{Arguments:}
 175 @table @asis
 176 @item @code{arg1: int}
 177 the first argument
 178 @item @code{arg2: string} (optional)
 179 the second
 180 argument
 181 @item @code{arg3: boolean}
 182 Not documented
 183 @end table
 184
 185 @b{Note:}
 186 @code{arg3} is undocumented
 187
 188 @b{Returns:}
 189 @code{Object}
 190
 191 @b{TODO:}
 192 frobnicate
 193
 194 @b{Notes:}
 195 @itemize @minus
 196 @item
 197 Lorem ipsum dolor sit amet
 198 @item
 199 Ut enim ad minim veniam
 200
 201 @end itemize
 202
 203 Duis aute irure dolor
 204
 205 @b{Example:}
 206 @example
 207 -> in
 208 <- out
 209 @end example
 210
 211 @b{Examples:}
 212 @example
 213 - *verbatim*
 214 - @{braces@}
 215 @end example
 216
 217 @b{Since:}
 218 2.10
 219
 220 @end deftypefn
 221
 222
 223
 224 @deftypefn Command {} cmd-boxed
 225
 226 If you're bored enough to read this, go see a video of boxed cats
 227
 228 @b{Arguments:} the members of @code{Object}
 229
 230 @b{Example:}
 231 @example
 232 -> in
 233
 234 <- out
 235 @end example
 236
 237 @end deftypefn
 238