tests/qapi-schema/doc-good.texi

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