Debian Codegraph @

testsuite/tests/tool-ocamldoc/Variants.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 modules" rel=Appendix href="index_modules.html">
11 <link title="Variants" rel="Chapter" href="Variants.html"><title>Variants</title>
12 </head>
13 <body>
14 <div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
15 &nbsp;</div>
16 <h1>Module <a href="type_Variants.html">Variants</a></h1>
17
18 <pre><span id="MODULEVariants"><span class="keyword">module</span> Variants</span>: <code class="code"><span class="keyword">sig</span></code> <a href="Variants.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
19 <div class="info-desc">
20 <p>This test is here to check the latex code generated for variants</p>
21 </div>
22 </div>
23 <hr width="100%">
24
25 <pre><code><span id="TYPEs"><span class="keyword">type</span> <code class="type"></code>s</span> = </code></pre><table class="typetable">
26 <tr>
27 <td align="left" valign="top" >
28 <code><span class="keyword">|</span></code></td>
29 <td align="left" valign="top" >
30 <code><span id="TYPEELTs.A"><span class="constructor">A</span></span></code></td>
31
32 </tr>
33 <tr>
34 <td align="left" valign="top" >
35 <code><span class="keyword">|</span></code></td>
36 <td align="left" valign="top" >
37 <code><span id="TYPEELTs.B"><span class="constructor">B</span></span></code></td>
38 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
39 <div class="info-desc">
40 <p>only B is documented here</p>
41 </div>
42 </div>
43 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
44 </tr>
45 <tr>
46 <td align="left" valign="top" >
47 <code><span class="keyword">|</span></code></td>
48 <td align="left" valign="top" >
49 <code><span id="TYPEELTs.C"><span class="constructor">C</span></span></code></td>
50
51 </tr></table>
52
53
54
55 <pre><code><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = </code></pre><table class="typetable">
56 <tr>
57 <td align="left" valign="top" >
58 <code><span class="keyword">|</span></code></td>
59 <td align="left" valign="top" >
60 <code><span id="TYPEELTt.A"><span class="constructor">A</span></span></code></td>
61 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
62 <div class="info-desc">
63 <p>doc for A.</p>
64 <pre class="codepre"><code class="code">0</code></pre><p>With three paragraphs.</p>
65 <pre class="codepre"><code class="code">1</code></pre><p>To check styling</p>
66 </div>
67 </div>
68 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
69 </tr>
70 <tr>
71 <td align="left" valign="top" >
72 <code><span class="keyword">|</span></code></td>
73 <td align="left" valign="top" >
74 <code><span id="TYPEELTt.B"><span class="constructor">B</span></span></code></td>
75 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
76 <div class="info-desc">
77 <p>doc for B</p>
78 </div>
79 </div>
80 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
81 </tr></table>
82
83
84
85 <pre><code><span id="TYPEu"><span class="keyword">type</span> <code class="type"></code>u</span> = </code></pre><table class="typetable">
86 <tr>
87 <td align="left" valign="top" >
88 <code><span class="keyword">|</span></code></td>
89 <td align="left" valign="top" >
90 <code><span id="TYPEELTu.A"><span class="constructor">A</span></span></code></td>
91 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
92 <div class="info-desc">
93 <p>doc for A</p>
94 </div>
95 </div>
96 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
97 </tr>
98 <tr>
99 <td align="left" valign="top" >
100 <code><span class="keyword">|</span></code></td>
101 <td align="left" valign="top" >
102 <code><span id="TYPEELTu.B"><span class="constructor">B</span></span> <span class="keyword">of</span> <code class="type">unit</code></code></td>
103 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
104 <div class="info-desc">
105 <p>doc for B</p>
106 </div>
107 </div>
108 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
109 </tr></table>
110
111 <div class="info ">
112 <div class="info-desc">
113 <p>Some documentation for u</p>
114 </div>
115 </div>
116
117
118 <pre><code><span id="TYPEw"><span class="keyword">type</span> <code class="type"></code>w</span> = </code></pre><table class="typetable">
119 <tr>
120 <td align="left" valign="top" >
121 <code><span class="keyword">|</span></code></td>
122 <td align="left" valign="top" >
123 <code><span id="TYPEELTw.A"><span class="constructor">A</span></span> <span class="keyword">of</span> <code>{</code><table class="typetable">
124 <tr>
125 <td align="left" valign="top" >
126 <code>&nbsp;&nbsp;</code></td>
127 <td align="left" valign="top" >
128 <code><span id="TYPEELTVariants.A.x">x</span>&nbsp;: <code class="type">int</code>;</code></td>
129
130 </tr></table>
131 <code>}</code>
132 </code></td>
133 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
134 <div class="info-desc">
135 <p>doc for A</p>
136 </div>
137 </div>
138 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
139 </tr>
140 <tr>
141 <td align="left" valign="top" >
142 <code><span class="keyword">|</span></code></td>
143 <td align="left" valign="top" >
144 <code><span id="TYPEELTw.B"><span class="constructor">B</span></span> <span class="keyword">of</span> <code>{</code><table class="typetable">
145 <tr>
146 <td align="left" valign="top" >
147 <code>&nbsp;&nbsp;</code></td>
148 <td align="left" valign="top" >
149 <code><span id="TYPEELTVariants.B.y">y</span>&nbsp;: <code class="type">int</code>;</code></td>
150
151 </tr></table>
152 <code>}</code>
153 </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>doc for B</p>
157 </div>
158 </div>
159 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
160 </tr></table>
161
162 <div class="info ">
163 <div class="info-desc">
164 <p>With records</p>
165 </div>
166 </div>
167
168
169 <pre><code><span id="TYPEz"><span class="keyword">type</span> <code class="type"></code>z</span> = </code></pre><table class="typetable">
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="TYPEELTz.A"><span class="constructor">A</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td>
175 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
176 <div class="info-desc">
177 <p>doc for A</p>
178 </div>
179 </div>
180 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
181 </tr>
182 <tr>
183 <td align="left" valign="top" >
184 <code><span class="keyword">|</span></code></td>
185 <td align="left" valign="top" >
186 <code><span id="TYPEELTz.B"><span class="constructor">B</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td>
187 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
188 <div class="info-desc">
189 <p>doc for B</p>
190 </div>
191 </div>
192 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
193 </tr></table>
194
195 <div class="info ">
196 <div class="info-desc">
197 <p>With args</p>
198 </div>
199 </div>
200
201
202 <pre><code><span id="TYPEa"><span class="keyword">type</span> <code class="type"></code>a</span> = </code></pre><table class="typetable">
203 <tr>
204 <td align="left" valign="top" >
205 <code><span class="keyword">|</span></code></td>
206 <td align="left" valign="top" >
207 <code><span id="TYPEELTa.A"><span class="constructor">A</span></span> <span class="keyword">:</span> <code class="type"><a href="Variants.html#TYPEa">a</a></code></code></td>
208 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
209 <div class="info-desc">
210 <p>doc for A</p>
211 </div>
212 </div>
213 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
214 </tr></table>
215
216 <div class="info ">
217 <div class="info-desc">
218 <p>Gadt notation</p>
219 </div>
220 </div>
221
222
223 <pre><code><span id="TYPEb"><span class="keyword">type</span> <code class="type"></code>b</span> = </code></pre><table class="typetable">
224 <tr>
225 <td align="left" valign="top" >
226 <code><span class="keyword">|</span></code></td>
227 <td align="left" valign="top" >
228 <code><span id="TYPEELTb.B"><span class="constructor">B</span></span></code></td>
229 <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
230 <div class="info-desc">
231 <p>doc for B</p>
232 </div>
233 </div>
234 </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
235 </tr></table>
236
237 <div class="info ">
238 <div class="info-desc">
239 <p>Lonely constructor</p>
240 </div>
241 </div>
242
243
244 <pre><code><span id="TYPEno_documentation"><span class="keyword">type</span> <code class="type"></code>no_documentation</span> = </code></pre><table class="typetable">
245 <tr>
246 <td align="left" valign="top" >
247 <code><span class="keyword">|</span></code></td>
248 <td align="left" valign="top" >
249 <code><span id="TYPEELTno_documentation.A"><span class="constructor">A</span></span></code></td>
250
251 </tr>
252 <tr>
253 <td align="left" valign="top" >
254 <code><span class="keyword">|</span></code></td>
255 <td align="left" valign="top" >
256 <code><span id="TYPEELTno_documentation.B"><span class="constructor">B</span></span></code></td>
257
258 </tr>
259 <tr>
260 <td align="left" valign="top" >
261 <code><span class="keyword">|</span></code></td>
262 <td align="left" valign="top" >
263 <code><span id="TYPEELTno_documentation.C"><span class="constructor">C</span></span></code></td>
264
265 </tr></table>
266
267
268
269 <pre><code><span id="TYPEe"><span class="keyword">type</span> <code class="type"></code>e</span> = </code></pre><table class="typetable">
270 <tr>
271 <td align="left" valign="top" >
272 <code><span class="keyword">|</span></code></td>
273 <td align="left" valign="top" >
274 <code></table>
275
276 <div class="info ">
277 <div class="info-desc">
278 <p>Empty variant</p>
279 </div>
280 </div>
281
282 </body></html>