]>
Commit | Line | Data |
---|---|---|
c263de3f MA |
1 | @c AUTOMATICALLY GENERATED, DO NOT MODIFY |
2 | ||
80d1f2e4 MA |
3 | @section Section |
4 | ||
5 | @subsection Subsection | |
6 | ||
c32617a1 | 7 | @strong{strong} @emph{with emphasis} |
80d1f2e4 MA |
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 | |
c32617a1 | 72 | @strong{verbatim} |
80d1f2e4 MA |
73 | @item |
74 | @{braces@} | |
75 | @end itemize | |
76 | ||
77 | ||
78 | ||
79 | @deftp {Enum} Enum | |
80 | ||
cfa438ff | 81 | |
80d1f2e4 MA |
82 | |
83 | @b{Values:} | |
84 | @table @asis | |
85 | @item @code{one} | |
c32617a1 | 86 | The @emph{one} @{and only@} |
a35c9bf8 | 87 | @*@b{If:} @code{defined(IFONE)} |
80d1f2e4 MA |
88 | @item @code{two} |
89 | Not documented | |
90 | @end table | |
013b4efc MA |
91 | |
92 | @b{Features:} | |
93 | @table @asis | |
94 | @item @code{enum-feat} | |
95 | Also @emph{one} @{and only@} | |
96 | @end table | |
80d1f2e4 MA |
97 | @code{two} is undocumented |
98 | ||
901a34a4 | 99 | @b{If:} @code{defined(IFCOND)} |
80d1f2e4 MA |
100 | @end deftp |
101 | ||
102 | ||
103 | ||
104 | @deftp {Object} Base | |
105 | ||
106 | ||
107 | ||
108 | @b{Members:} | |
109 | @table @asis | |
110 | @item @code{base1: Enum} | |
111 | the first member | |
112 | @end table | |
113 | ||
80d1f2e4 MA |
114 | @end deftp |
115 | ||
116 | ||
117 | ||
118 | @deftp {Object} Variant1 | |
119 | ||
120 | A paragraph | |
121 | ||
122 | Another paragraph (but no @code{var}: line) | |
123 | ||
124 | @b{Members:} | |
125 | @table @asis | |
126 | @item @code{var1: string} | |
127 | Not documented | |
8867bf08 | 128 | @*@b{If:} @code{defined(IFSTR)} |
80d1f2e4 MA |
129 | @end table |
130 | ||
79598c8a MA |
131 | @b{Features:} |
132 | @table @asis | |
133 | @item @code{variant1-feat} | |
134 | a feature | |
84ab0086 MA |
135 | @item @code{member-feat} |
136 | a member feature | |
79598c8a MA |
137 | @end table |
138 | ||
80d1f2e4 MA |
139 | @end deftp |
140 | ||
141 | ||
142 | ||
143 | @deftp {Object} Variant2 | |
144 | ||
145 | ||
146 | ||
80d1f2e4 MA |
147 | @end deftp |
148 | ||
149 | ||
150 | ||
151 | @deftp {Object} Object | |
152 | ||
153 | ||
154 | ||
155 | @b{Members:} | |
156 | @table @asis | |
157 | @item The members of @code{Base} | |
158 | @item The members of @code{Variant1} when @code{base1} is @t{"one"} | |
01ae9cc2 | 159 | @item The members of @code{Variant2} when @code{base1} is @t{"two"} (@b{If:} @code{IFTWO}) |
80d1f2e4 MA |
160 | @end table |
161 | ||
013b4efc MA |
162 | @b{Features:} |
163 | @table @asis | |
164 | @item @code{union-feat1} | |
165 | a feature | |
166 | @end table | |
167 | ||
80d1f2e4 MA |
168 | @end deftp |
169 | ||
170 | ||
171 | ||
172 | @deftp {Object} SugaredUnion | |
173 | ||
174 | ||
175 | ||
176 | @b{Members:} | |
177 | @table @asis | |
178 | @item @code{type} | |
179 | One of @t{"one"}, @t{"two"} | |
180 | @item @code{data: Variant1} when @code{type} is @t{"one"} | |
01ae9cc2 | 181 | @item @code{data: Variant2} when @code{type} is @t{"two"} (@b{If:} @code{IFTWO}) |
80d1f2e4 MA |
182 | @end table |
183 | ||
013b4efc MA |
184 | @b{Features:} |
185 | @table @asis | |
186 | @item @code{union-feat2} | |
187 | a feature | |
188 | @end table | |
189 | ||
80d1f2e4 MA |
190 | @end deftp |
191 | ||
192 | ||
f6401deb MA |
193 | |
194 | @deftp {Alternate} Alternate | |
195 | ||
196 | ||
197 | ||
198 | @b{Members:} | |
199 | @table @asis | |
200 | @item @code{i: int} | |
201 | an integer | |
202 | @code{b} is undocumented | |
203 | @item @code{b: boolean} | |
204 | Not documented | |
205 | @end table | |
206 | ||
013b4efc MA |
207 | @b{Features:} |
208 | @table @asis | |
209 | @item @code{alt-feat} | |
210 | a feature | |
211 | @end table | |
212 | ||
f6401deb MA |
213 | @end deftp |
214 | ||
215 | ||
80d1f2e4 MA |
216 | @subsection Another subsection |
217 | ||
218 | ||
219 | @deftypefn Command {} cmd | |
220 | ||
221 | ||
222 | ||
223 | @b{Arguments:} | |
224 | @table @asis | |
225 | @item @code{arg1: int} | |
226 | the first argument | |
227 | @item @code{arg2: string} (optional) | |
228 | the second | |
229 | argument | |
230 | @item @code{arg3: boolean} | |
231 | Not documented | |
232 | @end table | |
233 | ||
79598c8a MA |
234 | @b{Features:} |
235 | @table @asis | |
236 | @item @code{cmd-feat1} | |
237 | a feature | |
238 | @item @code{cmd-feat2} | |
239 | another feature | |
240 | @end table | |
241 | ||
80d1f2e4 MA |
242 | @b{Note:} |
243 | @code{arg3} is undocumented | |
244 | ||
245 | @b{Returns:} | |
246 | @code{Object} | |
247 | ||
248 | @b{TODO:} | |
249 | frobnicate | |
250 | ||
251 | @b{Notes:} | |
252 | @itemize @minus | |
253 | @item | |
254 | Lorem ipsum dolor sit amet | |
255 | @item | |
256 | Ut enim ad minim veniam | |
257 | ||
258 | @end itemize | |
259 | ||
260 | Duis aute irure dolor | |
261 | ||
262 | @b{Example:} | |
263 | @example | |
264 | -> in | |
265 | <- out | |
266 | @end example | |
267 | ||
80d1f2e4 MA |
268 | @b{Examples:} |
269 | @example | |
270 | - *verbatim* | |
271 | - @{braces@} | |
272 | @end example | |
273 | ||
80d1f2e4 MA |
274 | @b{Since:} |
275 | 2.10 | |
276 | ||
277 | @end deftypefn | |
278 | ||
279 | ||
280 | ||
281 | @deftypefn Command {} cmd-boxed | |
282 | ||
283 | If you're bored enough to read this, go see a video of boxed cats | |
284 | ||
285 | @b{Arguments:} the members of @code{Object} | |
286 | ||
79598c8a MA |
287 | @b{Features:} |
288 | @table @asis | |
289 | @item @code{cmd-feat1} | |
290 | a feature | |
291 | @item @code{cmd-feat2} | |
292 | another feature | |
293 | @end table | |
294 | ||
80d1f2e4 MA |
295 | @b{Example:} |
296 | @example | |
297 | -> in | |
298 | ||
299 | <- out | |
300 | @end example | |
301 | ||
80d1f2e4 MA |
302 | @end deftypefn |
303 | ||
717cfcfa MA |
304 | |
305 | ||
306 | @deftypefn Event {} EVT-BOXED | |
307 | ||
b621a260 MA |
308 | |
309 | ||
310 | @b{Arguments:} the members of @code{Object} | |
717cfcfa | 311 | |
013b4efc MA |
312 | @b{Features:} |
313 | @table @asis | |
314 | @item @code{feat3} | |
315 | a feature | |
316 | @end table | |
317 | ||
717cfcfa MA |
318 | @end deftypefn |
319 |