migration: Inactivate images after .save_live_complete_precopy()
[qemu/kevin.git] / tests / qapi-schema / doc-good.texi
blobc410626e4aafe1dea041315be6e157f988d29398
1 @section Section
3 @subsection Subsection
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
14 @item
15 Three
16 Still in list
18 @end itemize
20 Not in list
21 @itemize @minus
22 @item
23 Second list
24 Note: still in list
26 @end itemize
28 Note: not in list
29 @enumerate
30 @item
31 Third list
32 is numbered
34 @item
35 another item
37 @example
38 example
39 @end example
41 @example
42 multiple lines
43 @end example
46 @end enumerate
48 Returns: the King
49 Since: the first age
50 Notes:
52 @enumerate
53 @item
54 Lorem ipsum dolor sit amet
56 @item
57 Ut enim ad minim veniam
59 @end enumerate
61 Duis aute irure dolor
63 Example:
65 -> in
66 <- out
67 Examples:
68 @itemize @minus
69 @item
70 @strong{verbatim}
71 @item
72 @{braces@}
73 @end itemize
77 @deftp {Enum} Enum
79 @subsection Produces @strong{invalid} texinfo
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
90 @end deftp
94 @deftp {Object} Base
98 @b{Members:}
99 @table @asis
100 @item @code{base1: Enum}
101 the first member
102 @end table
105 @end deftp
109 @deftp {Object} Variant1
111 A paragraph
113 Another paragraph (but no @code{var}: line)
115 @b{Members:}
116 @table @asis
117 @item @code{var1: string}
118 Not documented
119 @end table
122 @end deftp
126 @deftp {Object} Variant2
131 @end deftp
135 @deftp {Object} Object
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
147 @end deftp
151 @deftp {Object} SugaredUnion
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
164 @end deftp
167 @subsection Another subsection
170 @deftypefn Command {} cmd
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
186 @b{Note:}
187 @code{arg3} is undocumented
189 @b{Returns:}
190 @code{Object}
192 @b{TODO:}
193 frobnicate
195 @b{Notes:}
196 @itemize @minus
197 @item
198 Lorem ipsum dolor sit amet
199 @item
200 Ut enim ad minim veniam
202 @end itemize
204 Duis aute irure dolor
206 @b{Example:}
207 @example
208 -> in
209 <- out
210 @end example
213 @b{Examples:}
214 @example
215 - *verbatim*
216 - @{braces@}
217 @end example
220 @b{Since:}
221 2.10
223 @end deftypefn
227 @deftypefn Command {} cmd-boxed
229 If you're bored enough to read this, go see a video of boxed cats
231 @b{Arguments:} the members of @code{Object}
233 @b{Example:}
234 @example
235 -> in
237 <- out
238 @end example
241 @end deftypefn