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 @item @code{two}
  88 Not documented
  89 @end table
  90 @code{two} is undocumented
  91
  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 @end table
 123
 124 @end deftp
 125
 126
 127
 128 @deftp {Object} Variant2
 129
 130
 131
 132 @end deftp
 133
 134
 135
 136 @deftp {Object} Object
 137
 138
 139
 140 @b{Members:}
 141 @table @asis
 142 @item The members of @code{Base}
 143 @item The members of @code{Variant1} when @code{base1} is @t{"one"}
 144 @item The members of @code{Variant2} when @code{base1} is @t{"two"}
 145 @end table
 146
 147 @end deftp
 148
 149
 150
 151 @deftp {Object} SugaredUnion
 152
 153
 154
 155 @b{Members:}
 156 @table @asis
 157 @item @code{type}
 158 One of @t{"one"}, @t{"two"}
 159 @item @code{data: Variant1} when @code{type} is @t{"one"}
 160 @item @code{data: Variant2} when @code{type} is @t{"two"}
 161 @end table
 162
 163 @end deftp
 164
 165
 166 @subsection Another subsection
 167
 168
 169 @deftypefn Command {} cmd
 170
 171
 172
 173 @b{Arguments:}
 174 @table @asis
 175 @item @code{arg1: int}
 176 the first argument
 177 @item @code{arg2: string} (optional)
 178 the second
 179 argument
 180 @item @code{arg3: boolean}
 181 Not documented
 182 @end table
 183
 184 @b{Note:}
 185 @code{arg3} is undocumented
 186
 187 @b{Returns:}
 188 @code{Object}
 189
 190 @b{TODO:}
 191 frobnicate
 192
 193 @b{Notes:}
 194 @itemize @minus
 195 @item
 196 Lorem ipsum dolor sit amet
 197 @item
 198 Ut enim ad minim veniam
 199
 200 @end itemize
 201
 202 Duis aute irure dolor
 203
 204 @b{Example:}
 205 @example
 206 -> in
 207 <- out
 208 @end example
 209
 210 @b{Examples:}
 211 @example
 212 - *verbatim*
 213 - @{braces@}
 214 @end example
 215
 216 @b{Since:}
 217 2.10
 218
 219 @end deftypefn
 220
 221
 222
 223 @deftypefn Command {} cmd-boxed
 224
 225 If you're bored enough to read this, go see a video of boxed cats
 226
 227 @b{Arguments:} the members of @code{Object}
 228
 229 @b{Example:}
 230 @example
 231 -> in
 232
 233 <- out
 234 @end example
 235
 236 @end deftypefn
 237