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 @subsection Produces @strong{invalid} texinfo
  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
 105 @end deftp
 106
 107
 108
 109 @deftp {Object} Variant1
 110
 111 A paragraph
 112
 113 Another paragraph (but no @code{var}: line)
 114
 115 @b{Members:}
 116 @table @asis
 117 @item @code{var1: string}
 118 Not documented
 119 @end table
 120
 121
 122 @end deftp
 123
 124
 125
 126 @deftp {Object} Variant2
 127
 128
 129
 130
 131 @end deftp
 132
 133
 134
 135 @deftp {Object} Object
 136
 137
 138
 139 @b{Members:}
 140 @table @asis
 141 @item The members of @code{Base}
 142 @item The members of @code{Variant1} when @code{base1} is @t{"one"}
 143 @item The members of @code{Variant2} when @code{base1} is @t{"two"}
 144 @end table
 145
 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
 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
 186 @b{Note:}
 187 @code{arg3} is undocumented
 188
 189 @b{Returns:}
 190 @code{Object}
 191
 192 @b{TODO:}
 193 frobnicate
 194
 195 @b{Notes:}
 196 @itemize @minus
 197 @item
 198 Lorem ipsum dolor sit amet
 199 @item
 200 Ut enim ad minim veniam
 201
 202 @end itemize
 203
 204 Duis aute irure dolor
 205
 206 @b{Example:}
 207 @example
 208 -> in
 209 <- out
 210 @end example
 211
 212
 213 @b{Examples:}
 214 @example
 215 - *verbatim*
 216 - @{braces@}
 217 @end example
 218
 219
 220 @b{Since:}
 221 2.10
 222
 223 @end deftypefn
 224
 225
 226
 227 @deftypefn Command {} cmd-boxed
 228
 229 If you're bored enough to read this, go see a video of boxed cats
 230
 231 @b{Arguments:} the members of @code{Object}
 232
 233 @b{Example:}
 234 @example
 235 -> in
 236
 237 <- out
 238 @end example
 239
 240
 241 @end deftypefn
 242
 243