]>
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@} |
80d1f2e4 MA |
87 | @item @code{two} |
88 | Not documented | |
89 | @end table | |
90 | @code{two} is undocumented | |
91 | ||
92 | @end deftp | |
93 | ||
94 | ||
95 | ||
96 | @deftp {Object} Base | |
97 | ||
98 | ||
99 | ||
100 | @b{Members:} | |
101 | @table @asis | |
102 | @item @code{base1: Enum} | |
103 | the first member | |
104 | @end table | |
105 | ||
80d1f2e4 MA |
106 | @end deftp |
107 | ||
108 | ||
109 | ||
110 | @deftp {Object} Variant1 | |
111 | ||
112 | A paragraph | |
113 | ||
114 | Another paragraph (but no @code{var}: line) | |
115 | ||
116 | @b{Members:} | |
117 | @table @asis | |
118 | @item @code{var1: string} | |
119 | Not documented | |
120 | @end table | |
121 | ||
80d1f2e4 MA |
122 | @end deftp |
123 | ||
124 | ||
125 | ||
126 | @deftp {Object} Variant2 | |
127 | ||
128 | ||
129 | ||
80d1f2e4 MA |
130 | @end deftp |
131 | ||
132 | ||
133 | ||
134 | @deftp {Object} Object | |
135 | ||
136 | ||
137 | ||
138 | @b{Members:} | |
139 | @table @asis | |
140 | @item The members of @code{Base} | |
141 | @item The members of @code{Variant1} when @code{base1} is @t{"one"} | |
142 | @item The members of @code{Variant2} when @code{base1} is @t{"two"} | |
143 | @end table | |
144 | ||
80d1f2e4 MA |
145 | @end deftp |
146 | ||
147 | ||
148 | ||
149 | @deftp {Object} SugaredUnion | |
150 | ||
151 | ||
152 | ||
153 | @b{Members:} | |
154 | @table @asis | |
155 | @item @code{type} | |
156 | One of @t{"one"}, @t{"two"} | |
157 | @item @code{data: Variant1} when @code{type} is @t{"one"} | |
158 | @item @code{data: Variant2} when @code{type} is @t{"two"} | |
159 | @end table | |
160 | ||
80d1f2e4 MA |
161 | @end deftp |
162 | ||
163 | ||
164 | @subsection Another subsection | |
165 | ||
166 | ||
167 | @deftypefn Command {} cmd | |
168 | ||
169 | ||
170 | ||
171 | @b{Arguments:} | |
172 | @table @asis | |
173 | @item @code{arg1: int} | |
174 | the first argument | |
175 | @item @code{arg2: string} (optional) | |
176 | the second | |
177 | argument | |
178 | @item @code{arg3: boolean} | |
179 | Not documented | |
180 | @end table | |
181 | ||
80d1f2e4 MA |
182 | @b{Note:} |
183 | @code{arg3} is undocumented | |
184 | ||
185 | @b{Returns:} | |
186 | @code{Object} | |
187 | ||
188 | @b{TODO:} | |
189 | frobnicate | |
190 | ||
191 | @b{Notes:} | |
192 | @itemize @minus | |
193 | @item | |
194 | Lorem ipsum dolor sit amet | |
195 | @item | |
196 | Ut enim ad minim veniam | |
197 | ||
198 | @end itemize | |
199 | ||
200 | Duis aute irure dolor | |
201 | ||
202 | @b{Example:} | |
203 | @example | |
204 | -> in | |
205 | <- out | |
206 | @end example | |
207 | ||
80d1f2e4 MA |
208 | @b{Examples:} |
209 | @example | |
210 | - *verbatim* | |
211 | - @{braces@} | |
212 | @end example | |
213 | ||
80d1f2e4 MA |
214 | @b{Since:} |
215 | 2.10 | |
216 | ||
217 | @end deftypefn | |
218 | ||
219 | ||
220 | ||
221 | @deftypefn Command {} cmd-boxed | |
222 | ||
223 | If you're bored enough to read this, go see a video of boxed cats | |
224 | ||
225 | @b{Arguments:} the members of @code{Object} | |
226 | ||
227 | @b{Example:} | |
228 | @example | |
229 | -> in | |
230 | ||
231 | <- out | |
232 | @end example | |
233 | ||
80d1f2e4 MA |
234 | @end deftypefn |
235 |