@samitouri / QOSamiQemu
Code Commits Issues Pulls Sessions CI/CD
master
master
txt 181 lines 2.92 KB
Raw
1 Section
2 *******
3
4 Just text, no heading.
5
6
7 Subsection
8 ==========
9
10 *with emphasis* "var" {in braces}
11
12 * List item one
13
14 * Two, multiple lines
15
16 * Three Still in list
17
18 Not in list
19
20 * Second list Note: still in list
21
22 Note: not in list
23
24 1. Third list is numbered
25
26 2. another item
27
28 Returns: the King Since: the first age Notes:
29
30 1. Lorem ipsum dolor sit amet
31
32 2. Ut enim ad minim veniam
33
34 Duis aute irure dolor
35
36 Example:
37
38 -> in <- out Examples: - *verbatim* - {braces}
39
40 Enum Enum
41 *Availability*: "IFCOND"
42
43 Values:
44 * **one** -- The _one_ {and only}, description on the same line
45
46 * **two** -- Not documented
47
48 Features:
49 * **enum-feat** -- Also _one_ {and only}
50
51 * **enum-member-feat** -- a member feature
52
53 "two" is undocumented
54
55 Object Base
56 *Availability*: "IFALL1 and IFALL2"
57
58 Members:
59 * **base1** ("Enum") -- description starts on a new line,
60 minimally indented
61
62 Object Variant1
63
64 A paragraph
65
66 Another paragraph
67
68 "var1" is undocumented
69
70 Members:
71 * **var1** ("string") -- Not documented
72
73 Features:
74 * **variant1-feat** -- a feature
75
76 * **member-feat** -- a member feature
77
78 Object Variant2
79
80 Object Object
81
82 Members:
83 * The members of "Base".
84
85 * When "base1" is "one": The members of "Variant1".
86
87 * When "base1" is "two": The members of "Variant2".
88
89 Features:
90 * **union-feat1** -- a feature
91
92 Alternate Alternate
93 *Availability*: "not (IFONE or IFTWO)"
94
95 Alternatives:
96 * **i** ("int") -- description starts on the same line remainder
97 indented the same "b" is undocumented
98
99 * **b** ("boolean") -- Not documented
100
101 Features:
102 * **alt-feat** -- a feature
103
104
105 Another subsection
106 ==================
107
108 Command cmd (Since: 2.10)
109
110 Arguments:
111 * **arg1** ("int") -- description starts on a new line, indented
112
113 * **arg2** ("string", *optional*) -- description starts on the
114 same line remainder indented differently
115
116 * **arg3** ("boolean") -- Not documented
117
118 Features:
119 * **cmd-feat1** -- a feature
120
121 * **cmd-feat2** -- another feature
122
123 Note:
124
125 "arg3" is undocumented
126
127 Return:
128 "Object" -- "Object"
129
130 Errors:
131 some
132
133 Notes:
134
135 * Lorem ipsum dolor sit amet
136
137 * Ut enim ad minim veniam
138
139 Duis aute irure dolor
140
141 Example: Ideal fast-food burger situation:
142
143 -> "in"
144 <- "out"
145
146 Examples:
147
148 - Not a QMP code block
149 - Merely a preformatted code block literal
150 It isn't even an rST list.
151 - *verbatim*
152 - {braces}
153
154 Note::
155 Ceci n'est pas une note
156
157 Command cmd-boxed
158
159 If you're bored enough to read this, go see a video of boxed cats
160
161 Arguments:
162 * The members of "Object".
163
164 Features:
165 * **cmd-feat1** -- a feature
166
167 * **cmd-feat2** -- another feature
168
169 Example::
170
171 -> "this example"
172
173 <- ... has no title ...
174
175 Event EVT_BOXED
176
177 Members:
178 * The members of "Object".
179
180 Features:
181 * **feat3** -- a feature