this repo has no description
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml">
3 <head><title>Toplevel_comments (Toplevel_comments)</title>
4 <meta charset="utf-8"/><link rel="stylesheet" href="odoc.css"/>
5 <meta name="generator" content="odoc %%VERSION%%"/>
6 <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
7 <script src="highlight.pack.js"></script>
8 <script>hljs.initHighlightingOnLoad();</script>
9 </head>
10 <body class="odoc">
11 <nav class="odoc-nav"><a href="index.html">Up</a> –
12 <a href="index.html">Index</a> » Toplevel_comments
13 </nav>
14 <header class="odoc-preamble">
15 <h1>Module <code><span>Toplevel_comments</span></code></h1>
16 <p>A doc comment at the beginning of a module is considered to be
17 that module's doc.
18 </p>
19 </header>
20 <div class="odoc-content">
21 <div class="odoc-spec">
22 <div class="spec module-type anchored" id="module-type-T">
23 <a href="#module-type-T" class="anchor"></a>
24 <code>
25 <span><span class="keyword">module</span>
26 <span class="keyword">type</span>
27 <a href="Toplevel_comments-module-type-T.html">T</a>
28 </span>
29 <span> = <span class="keyword">sig</span> ...
30 <span class="keyword">end</span>
31 </span>
32 </code>
33 </div><div class="spec-doc"><p>Doc of <code>T</code>, part 1.</p></div>
34 </div>
35 <div class="odoc-spec">
36 <div class="spec module anchored" id="module-Include_inline">
37 <a href="#module-Include_inline" class="anchor"></a>
38 <code>
39 <span><span class="keyword">module</span>
40 <a href="Toplevel_comments-Include_inline.html">Include_inline</a>
41 </span>
42 <span> : <span class="keyword">sig</span> ...
43 <span class="keyword">end</span>
44 </span>
45 </code>
46 </div><div class="spec-doc"><p>Doc of <code>T</code>, part 2.</p></div>
47 </div>
48 <div class="odoc-spec">
49 <div class="spec module anchored" id="module-Include_inline'">
50 <a href="#module-Include_inline'" class="anchor"></a>
51 <code>
52 <span><span class="keyword">module</span>
53 <a href="Toplevel_comments-Include_inline'.html">Include_inline'</a>
54 </span>
55 <span> : <span class="keyword">sig</span> ...
56 <span class="keyword">end</span>
57 </span>
58 </code>
59 </div>
60 <div class="spec-doc"><p>Doc of <code>Include_inline</code>, part 1.</p>
61 </div>
62 </div>
63 <div class="odoc-spec">
64 <div class="spec module-type anchored" id="module-type-Include_inline_T">
65 <a href="#module-type-Include_inline_T" class="anchor"></a>
66 <code>
67 <span><span class="keyword">module</span>
68 <span class="keyword">type</span>
69 <a href="Toplevel_comments-module-type-Include_inline_T.html">
70 Include_inline_T
71 </a>
72 </span>
73 <span> = <span class="keyword">sig</span> ...
74 <span class="keyword">end</span>
75 </span>
76 </code>
77 </div><div class="spec-doc"><p>Doc of <code>T</code>, part 2.</p></div>
78 </div>
79 <div class="odoc-spec">
80 <div class="spec module-type anchored" id="module-type-Include_inline_T'">
81 <a href="#module-type-Include_inline_T'" class="anchor"></a>
82 <code>
83 <span><span class="keyword">module</span>
84 <span class="keyword">type</span>
85 <a href="Toplevel_comments-module-type-Include_inline_T'.html">
86 Include_inline_T'
87 </a>
88 </span>
89 <span> = <span class="keyword">sig</span> ...
90 <span class="keyword">end</span>
91 </span>
92 </code>
93 </div>
94 <div class="spec-doc">
95 <p>Doc of <code>Include_inline_T'</code>, part 1.</p>
96 </div>
97 </div>
98 <div class="odoc-spec">
99 <div class="spec module anchored" id="module-M">
100 <a href="#module-M" class="anchor"></a>
101 <code>
102 <span><span class="keyword">module</span>
103 <a href="Toplevel_comments-M.html">M</a>
104 </span>
105 <span> : <span class="keyword">sig</span> ...
106 <span class="keyword">end</span>
107 </span>
108 </code>
109 </div><div class="spec-doc"><p>Doc of <code>M</code></p></div>
110 </div>
111 <div class="odoc-spec">
112 <div class="spec module anchored" id="module-M'">
113 <a href="#module-M'" class="anchor"></a>
114 <code>
115 <span><span class="keyword">module</span>
116 <a href="Toplevel_comments-M'.html">M'</a>
117 </span>
118 <span> : <span class="keyword">sig</span> ...
119 <span class="keyword">end</span>
120 </span>
121 </code>
122 </div>
123 <div class="spec-doc"><p>Doc of <code>M'</code> from outside</p></div>
124 </div>
125 <div class="odoc-spec">
126 <div class="spec module anchored" id="module-M''">
127 <a href="#module-M''" class="anchor"></a>
128 <code>
129 <span><span class="keyword">module</span>
130 <a href="Toplevel_comments-M''.html">M''</a>
131 </span>
132 <span> : <span class="keyword">sig</span> ...
133 <span class="keyword">end</span>
134 </span>
135 </code>
136 </div><div class="spec-doc"><p>Doc of <code>M''</code>, part 1.</p></div>
137 </div>
138 <div class="odoc-spec">
139 <div class="spec module anchored" id="module-Alias">
140 <a href="#module-Alias" class="anchor"></a>
141 <code>
142 <span><span class="keyword">module</span>
143 <a href="Toplevel_comments-Alias.html">Alias</a>
144 </span>
145 <span> :
146 <a href="Toplevel_comments-module-type-T.html">Toplevel_comments.T</a>
147 </span>
148 </code>
149 </div><div class="spec-doc"><p>Doc of <code>Alias</code>.</p></div>
150 </div>
151 <div class="odoc-spec">
152 <div class="spec class anchored" id="class-c1">
153 <a href="#class-c1" class="anchor"></a>
154 <code><span><span class="keyword">class</span> </span>
155 <span><a href="Toplevel_comments-class-c1.html">c1</a></span>
156 <span> : <span>int <span class="arrow">-></span></span>
157 <span class="keyword">object</span> ...
158 <span class="keyword">end</span>
159 </span>
160 </code>
161 </div><div class="spec-doc"><p>Doc of <code>c1</code>, part 1.</p></div>
162 </div>
163 <div class="odoc-spec">
164 <div class="spec class-type anchored" id="class-type-ct">
165 <a href="#class-type-ct" class="anchor"></a>
166 <code>
167 <span><span class="keyword">class</span>
168 <span class="keyword">type</span>
169 </span>
170 <span><a href="Toplevel_comments-class-type-ct.html">ct</a></span>
171 <span> = <span class="keyword">object</span> ...
172 <span class="keyword">end</span>
173 </span>
174 </code>
175 </div><div class="spec-doc"><p>Doc of <code>ct</code>, part 1.</p></div>
176 </div>
177 <div class="odoc-spec">
178 <div class="spec class anchored" id="class-c2">
179 <a href="#class-c2" class="anchor"></a>
180 <code><span><span class="keyword">class</span> </span>
181 <span><a href="Toplevel_comments-class-c2.html">c2</a></span>
182 <span> : <a href="Toplevel_comments-class-type-ct.html">ct</a></span>
183 </code>
184 </div><div class="spec-doc"><p>Doc of <code>c2</code>.</p></div>
185 </div>
186 <div class="odoc-spec">
187 <div class="spec module anchored" id="module-Ref_in_synopsis">
188 <a href="#module-Ref_in_synopsis" class="anchor"></a>
189 <code>
190 <span><span class="keyword">module</span>
191 <a href="Toplevel_comments-Ref_in_synopsis.html">Ref_in_synopsis</a>
192 </span>
193 <span> : <span class="keyword">sig</span> ...
194 <span class="keyword">end</span>
195 </span>
196 </code>
197 </div>
198 <div class="spec-doc">
199 <p>
200 <a href="Toplevel_comments-Ref_in_synopsis.html#type-t"><code>t</code>
201 </a>.
202 </p>
203 </div>
204 </div>
205 <div class="odoc-spec">
206 <div class="spec module anchored" id="module-Comments_on_open">
207 <a href="#module-Comments_on_open" class="anchor"></a>
208 <code>
209 <span><span class="keyword">module</span>
210 <a href="Toplevel_comments-Comments_on_open.html">Comments_on_open</a>
211 </span>
212 <span> : <span class="keyword">sig</span> ...
213 <span class="keyword">end</span>
214 </span>
215 </code>
216 </div>
217 </div>
218 </div>
219 </body>
220</html>