blob: 405055b14696f2a5fc8f8cc61ffe20ddc4a2a5fa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
@c AUTOMATICALLY GENERATED, DO NOT MODIFY
@section Section
@subsection Subsection
@strong{strong} @emph{with emphasis}
@code{var} @{in braces@}
@itemize @bullet
@item
List item one
@item
Two, multiple
lines
@item
Three
Still in list
@end itemize
Not in list
@itemize @minus
@item
Second list
Note: still in list
@end itemize
Note: not in list
@enumerate
@item
Third list
is numbered
@item
another item
@example
example
@end example
@example
multiple lines
@end example
@end enumerate
Returns: the King
Since: the first age
Notes:
@enumerate
@item
Lorem ipsum dolor sit amet
@item
Ut enim ad minim veniam
@end enumerate
Duis aute irure dolor
Example:
-> in
<- out
Examples:
@itemize @minus
@item
@strong{verbatim}
@item
@{braces@}
@end itemize
@deftp {Enum} Enum
@b{Values:}
@table @asis
@item @code{one}
The @emph{one} @{and only@}
@*@b{If:} @code{defined(IFONE)}
@item @code{two}
Not documented
@end table
@code{two} is undocumented
@b{If:} @code{defined(IFCOND)}
@end deftp
@deftp {Object} Base
@b{Members:}
@table @asis
@item @code{base1: Enum}
the first member
@end table
@end deftp
@deftp {Object} Variant1
A paragraph
Another paragraph (but no @code{var}: line)
@b{Members:}
@table @asis
@item @code{var1: string}
Not documented
@end table
@end deftp
@deftp {Object} Variant2
@end deftp
@deftp {Object} Object
@b{Members:}
@table @asis
@item The members of @code{Base}
@item The members of @code{Variant1} when @code{base1} is @t{"one"}
@item The members of @code{Variant2} when @code{base1} is @t{"two"}
@end table
@end deftp
@deftp {Object} SugaredUnion
@b{Members:}
@table @asis
@item @code{type}
One of @t{"one"}, @t{"two"}
@item @code{data: Variant1} when @code{type} is @t{"one"}
@item @code{data: Variant2} when @code{type} is @t{"two"}
@end table
@end deftp
@subsection Another subsection
@deftypefn Command {} cmd
@b{Arguments:}
@table @asis
@item @code{arg1: int}
the first argument
@item @code{arg2: string} (optional)
the second
argument
@item @code{arg3: boolean}
Not documented
@end table
@b{Note:}
@code{arg3} is undocumented
@b{Returns:}
@code{Object}
@b{TODO:}
frobnicate
@b{Notes:}
@itemize @minus
@item
Lorem ipsum dolor sit amet
@item
Ut enim ad minim veniam
@end itemize
Duis aute irure dolor
@b{Example:}
@example
-> in
<- out
@end example
@b{Examples:}
@example
- *verbatim*
- @{braces@}
@end example
@b{Since:}
2.10
@end deftypefn
@deftypefn Command {} cmd-boxed
If you're bored enough to read this, go see a video of boxed cats
@b{Arguments:} the members of @code{Object}
@b{Example:}
@example
-> in
<- out
@end example
@end deftypefn
|
