Debian Codegraph @

testsuite/tests/tool-ocamldoc/Inline_records.html.reference

raw
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <link rel="stylesheet" href="style.css" type="text/css">
5 <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
7 <link rel="Start" href="index.html">
8 <link rel="Up" href="index.html">
9 <link title="Index of types" rel=Appendix href="index_types.html">
10 <link title="Index of extensions" rel=Appendix href="index_extensions.html">
11 <link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
12 <link title="Index of modules" rel=Appendix href="index_modules.html">
13 <link title="Inline_records" rel="Chapter" href="Inline_records.html"><title>Inline_records</title>
14 </head>
15 <body>
16 <div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
17 &nbsp;</div>
18 <h1>Module <a href="type_Inline_records.html">Inline_records</a></h1>
19
20 <pre><span id="MODULEInline_records"><span class="keyword">module</span> Inline_records</span>: <code class="code"><span class="keyword">sig</span></code> <a href="Inline_records.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
21 <div class="info-desc">
22 <p>This test focuses on the printing of documentation for inline record
23 within the latex generator.</p>
24 </div>
25 </div>
26 <hr width="100%">
27
28 <pre><span id="EXCEPTIONSimple"><span class="keyword">exception</span> Simple</span></pre>
29 <div class="info ">
30 <div class="info-desc">
31 <p>A nice exception</p>
32 </div>
33 </div>
34
35 <pre><span id="EXCEPTIONLess"><span class="keyword">exception</span> Less</span> <span class="keyword">of</span> <code class="type">int</code></pre>
36 <div class="info ">
37 <div class="info-desc">
38 <p>A less simple exception</p>
39 </div>
40 </div>
41
42 <pre><span id="TYPEext"><span class="keyword">type</span> <code class="type"></code>ext</span> = ..</pre>
43 <div class="info ">
44 <div class="info-desc">
45 <p>An open sum type</p>
46 </div>
47 </div>
48
49
50 <pre><code><span id="TYPEr"><span class="keyword">type</span> <code class="type"></code>r</span> = {</code></pre><table class="typetable">
51 <tr>
52 <td align="left" valign="top" >
53 <code>&nbsp;&nbsp;</code></td>
54 <td align="left" valign="top" >
55 <code><span id="TYPEELTr.lbl">lbl</span>&nbsp;: <code class="type">int</code>;</code></td>
56 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
57 <div class="info-desc">
58 <p>Field documentation for non-inline, <code class="code">lbl&nbsp;:&nbsp;int</code></p>
59 </div>
60 </div>
61 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
62 </tr>
63 <tr>
64 <td align="left" valign="top" >
65 <code>&nbsp;&nbsp;</code></td>
66 <td align="left" valign="top" >
67 <code><span id="TYPEELTr.more">more</span>&nbsp;: <code class="type">int list</code>;</code></td>
68 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
69 <div class="info-desc">
70 <p>More documentation for r, <code class="code">more&nbsp;:&nbsp;int&nbsp;list</code></p>
71 </div>
72 </div>
73 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
74 </tr></table>
75 <code>}</code>
76
77 <div class="info ">
78 <div class="info-desc">
79 <p>A simple record type for reference</p>
80 </div>
81 </div>
82
83
84 <pre><code><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = </code></pre><table class="typetable">
85 <tr>
86 <td align="left" valign="top" >
87 <code><span class="keyword">|</span></code></td>
88 <td align="left" valign="top" >
89 <code><span id="TYPEELTt.A"><span class="constructor">A</span></span> <span class="keyword">of</span> <code>{</code><table class="typetable">
90 <tr>
91 <td align="left" valign="top" >
92 <code>&nbsp;&nbsp;</code></td>
93 <td align="left" valign="top" >
94 <code><span id="TYPEELTInline_records.A.lbl">lbl</span>&nbsp;: <code class="type">int</code>;</code></td>
95 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
96 <div class="info-desc">
97 <p><code class="code"><span class="constructor">A</span></code> field documentation</p>
98 </div>
99 </div>
100 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
101 </tr>
102 <tr>
103 <td align="left" valign="top" >
104 <code>&nbsp;&nbsp;</code></td>
105 <td align="left" valign="top" >
106 <code><span id="TYPEELTInline_records.A.more">more</span>&nbsp;: <code class="type">int list</code>;</code></td>
107 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
108 <div class="info-desc">
109 <p>More <code class="code"><span class="constructor">A</span></code> field documentation</p>
110 </div>
111 </div>
112 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
113 </tr></table>
114 <code>}</code>
115 </code></td>
116 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
117 <div class="info-desc">
118 <p>Constructor documentation</p>
119 </div>
120 </div>
121 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
122 </tr></table>
123
124 <div class="info ">
125 <div class="info-desc">
126 <p>A sum type with one inline record</p>
127 </div>
128 </div>
129
130
131 <pre><code><span id="TYPEs"><span class="keyword">type</span> <code class="type"></code>s</span> = </code></pre><table class="typetable">
132 <tr>
133 <td align="left" valign="top" >
134 <code><span class="keyword">|</span></code></td>
135 <td align="left" valign="top" >
136 <code><span id="TYPEELTs.B"><span class="constructor">B</span></span> <span class="keyword">of</span> <code>{</code><table class="typetable">
137 <tr>
138 <td align="left" valign="top" >
139 <code>&nbsp;&nbsp;</code></td>
140 <td align="left" valign="top" >
141 <code><span id="TYPEELTInline_records.B.a_label_for_B">a_label_for_B</span>&nbsp;: <code class="type">int</code>;</code></td>
142 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
143 <div class="info-desc">
144 <p><code class="code"><span class="constructor">B</span></code> field documentation</p>
145 </div>
146 </div>
147 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
148 </tr>
149 <tr>
150 <td align="left" valign="top" >
151 <code>&nbsp;&nbsp;</code></td>
152 <td align="left" valign="top" >
153 <code><span id="TYPEELTInline_records.B.more_label_for_B">more_label_for_B</span>&nbsp;: <code class="type">int list</code>;</code></td>
154 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
155 <div class="info-desc">
156 <p>More <code class="code"><span class="constructor">B</span></code> field documentation</p>
157 </div>
158 </div>
159 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
160 </tr></table>
161 <code>}</code>
162 </code></td>
163 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
164 <div class="info-desc">
165 <p>Constructor B documentation</p>
166 </div>
167 </div>
168 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
169 </tr>
170 <tr>
171 <td align="left" valign="top" >
172 <code><span class="keyword">|</span></code></td>
173 <td align="left" valign="top" >
174 <code><span id="TYPEELTs.C"><span class="constructor">C</span></span> <span class="keyword">of</span> <code>{</code><table class="typetable">
175 <tr>
176 <td align="left" valign="top" >
177 <code>&nbsp;&nbsp;</code></td>
178 <td align="left" valign="top" >
179 <code><span id="TYPEELTInline_records.C.c_has_label_too">c_has_label_too</span>&nbsp;: <code class="type">float</code>;</code></td>
180 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
181 <div class="info-desc">
182 <p><code class="code"><span class="constructor">C</span></code> field documentation</p>
183 </div>
184 </div>
185 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
186 </tr>
187 <tr>
188 <td align="left" valign="top" >
189 <code>&nbsp;&nbsp;</code></td>
190 <td align="left" valign="top" >
191 <code><span id="TYPEELTInline_records.C.more_than_one">more_than_one</span>&nbsp;: <code class="type">unit</code>;</code></td>
192 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
193 <div class="info-desc">
194 <p>... documentations</p>
195 </div>
196 </div>
197 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
198 </tr></table>
199 <code>}</code>
200 </code></td>
201 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
202 <div class="info-desc">
203 <p>Constructor C documentation</p>
204 </div>
205 </div>
206 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
207 </tr></table>
208
209 <div class="info ">
210 <div class="info-desc">
211 <p>A sum type with two inline records</p>
212 </div>
213 </div>
214
215
216 <pre><code><span id="TYPEany"><span class="keyword">type</span> <code class="type"></code>any</span> = </code></pre><table class="typetable">
217 <tr>
218 <td align="left" valign="top" >
219 <code><span class="keyword">|</span></code></td>
220 <td align="left" valign="top" >
221 <code><span id="TYPEELTany.D"><span class="constructor">D</span></span> <span class="keyword">:</span> <code>{</code><table class="typetable">
222 <tr>
223 <td align="left" valign="top" >
224 <code>&nbsp;&nbsp;</code></td>
225 <td align="left" valign="top" >
226 <code><span id="TYPEELTInline_records.D.any">any</span>&nbsp;: <code class="type">'a</code>;</code></td>
227 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
228 <div class="info-desc">
229 <p><code class="code"><span class="constructor">A</span></code> field <code class="code">any:<span class="keywordsign">'</span>a</code> for <code class="code"><span class="constructor">D</span></code> in <code class="code">any</code>.</p>
230 </div>
231 </div>
232 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
233 </tr></table>
234 <code>}</code>
235 <span class="keyword">-></span> <code class="type"><a href="Inline_records.html#TYPEany">any</a></code></code></td>
236 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
237 <div class="info-desc">
238 <p>Constructor D documentation</p>
239 </div>
240 </div>
241 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
242 </tr></table>
243
244 <div class="info ">
245 <div class="info-desc">
246 <p>A gadt constructor</p>
247 </div>
248 </div>
249
250
251 <pre><span id="EXCEPTIONError"><span class="keyword">exception</span> Error</span> <span class="keyword">of</span> <code>{</code><table class="typetable">
252 <tr>
253 <td align="left" valign="top" >
254 <code>&nbsp;&nbsp;</code></td>
255 <td align="left" valign="top" >
256 <code><span id="TYPEELTInline_records.Error.name">name</span>&nbsp;: <code class="type">string</code>;</code></td>
257 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
258 <div class="info-desc">
259 <p>Error field documentation <code class="code">name:string</code></p>
260 </div>
261 </div>
262 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
263 </tr></table>
264 <code>}</code>
265 </pre>
266 <pre><code><span class="keyword">type</span> <code class="type"></code><a href="Inline_records.html#TYPEext">ext</a> += </code></pre><table class="typetable">
267 <tr>
268 <td align="left" valign="top" >
269 <code><span class="keyword">|</span></code></td>
270 <td align="left" valign="top" >
271 <code><span id="EXTENSIONE">E</span> <span class="keyword">of</span> <code>{</code><table class="typetable">
272 <tr>
273 <td align="left" valign="top" >
274 <code>&nbsp;&nbsp;</code></td>
275 <td align="left" valign="top" >
276 <code><span id="TYPEELTInline_records.E.yet_another_field">yet_another_field</span>&nbsp;: <code class="type">unit</code>;</code></td>
277 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
278 <div class="info-desc">
279 <p>Field documentation for <code class="code"><span class="constructor">E</span></code> in ext</p>
280 </div>
281 </div>
282 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
283 </tr></table>
284 <code>}</code>
285 </code></td>
286 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
287 <div class="info-desc">
288 <p>Constructor E documentation</p>
289 </div>
290 </div>
291 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
292 </tr>
293 <tr>
294 <td align="left" valign="top" >
295 <code><span class="keyword">|</span></code></td>
296 <td align="left" valign="top" >
297 <code><span id="EXTENSIONF">F</span> <span class="keyword">of</span> <code>{</code><table class="typetable">
298 <tr>
299 <td align="left" valign="top" >
300 <code>&nbsp;&nbsp;</code></td>
301 <td align="left" valign="top" >
302 <code><span id="TYPEELTInline_records.F.even_more">even_more</span>&nbsp;: <code class="type">int -&gt; int</code>;</code></td>
303 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
304 <div class="info-desc">
305 <p>Some field documentations for <code class="code"><span class="constructor">F</span></code></p>
306 </div>
307 </div>
308 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
309 </tr></table>
310 <code>}</code>
311 </code></td>
312 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
313 <div class="info-desc">
314 <p>Constructor F documentation</p>
315 </div>
316 </div>
317 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
318 </tr>
319 <tr>
320 <td align="left" valign="top" >
321 <code><span class="keyword">|</span></code></td>
322 <td align="left" valign="top" >
323 <code><span id="EXTENSIONG">G</span> <span class="keyword">of</span> <code>{</code><table class="typetable">
324 <tr>
325 <td align="left" valign="top" >
326 <code>&nbsp;&nbsp;</code></td>
327 <td align="left" valign="top" >
328 <code><span id="TYPEELTInline_records.G.last">last</span>&nbsp;: <code class="type">int -&gt; int</code>;</code></td>
329 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
330 <div class="info-desc">
331 <p>The last and least field documentation</p>
332 </div>
333 </div>
334 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
335 </tr></table>
336 <code>}</code>
337 </code></td>
338 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
339 <div class="info-desc">
340 <p>Constructor G documentation</p>
341 </div>
342 </div>
343 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
344 </tr></table>
345
346 <div class="info ">
347 <div class="info-desc">
348 <p>Two new constructors for ext</p>
349 </div>
350 </div>
351
352 </body></html>