jon.recoil.org
this repo has no description
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml">
3 <head><title>Stop (Stop)</title><meta charset="utf-8"/>
4 <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> » Stop
13 </nav>
14 <header class="odoc-preamble">
15 <h1>Module <code><span>Stop</span></code></h1>
16 <p>This test cases exercises stop comments.</p>
17 </header>
18 <div class="odoc-content">
19 <div class="odoc-spec">
20 <div class="spec value anchored" id="val-foo">
21 <a href="#val-foo" class="anchor"></a>
22 <code><span><span class="keyword">val</span> foo : int</span></code>
23 </div><div class="spec-doc"><p>This is normal commented text.</p></div>
24 </div>
25 <p>The next value is <code>bar</code>, and it should be missing from
26 the documentation. There is also an entire module, <code>M</code>
27 , which should also be hidden. It contains a nested stop comment,
28 but that stop comment should not turn documentation back on in this
29 outer module, because stop comments respect scope.
30 </p><p>Documentation is on again.</p>
31 <p>Now, we have a nested module, and it has a stop comment between
32 its two items. We want to see that the first item is displayed,
33 but the second is missing, and the stop comment disables documenation
34 only in that module, and not in this outer module.
35 </p>
36 <div class="odoc-spec">
37 <div class="spec module anchored" id="module-N">
38 <a href="#module-N" class="anchor"></a>
39 <code>
40 <span><span class="keyword">module</span> <a href="Stop-N.html">N</a>
41 </span>
42 <span> : <span class="keyword">sig</span> ...
43 <span class="keyword">end</span>
44 </span>
45 </code>
46 </div>
47 </div>
48 <div class="odoc-spec">
49 <div class="spec value anchored" id="val-lol">
50 <a href="#val-lol" class="anchor"></a>
51 <code><span><span class="keyword">val</span> lol : int</span></code>
52 </div>
53 </div>
54 <p>The first comment can also be a stop-comment. The test case
55 <code>stop_first_comment.mli</code> is testing the same thing but
56 at the toplevel. We should see <code>bar</code> inside
57 <a href="Stop-O.html"><code>O</code></a>.
58 </p>
59 <div class="odoc-spec">
60 <div class="spec module anchored" id="module-O">
61 <a href="#module-O" class="anchor"></a>
62 <code>
63 <span><span class="keyword">module</span> <a href="Stop-O.html">O</a>
64 </span>
65 <span> : <span class="keyword">sig</span> ...
66 <span class="keyword">end</span>
67 </span>
68 </code>
69 </div>
70 </div><p>The top-comment computation must not mess with stop comments.</p>
71 <div class="odoc-spec">
72 <div class="spec module anchored" id="module-P">
73 <a href="#module-P" class="anchor"></a>
74 <code>
75 <span><span class="keyword">module</span> <a href="Stop-P.html">P</a>
76 </span>
77 <span> : <span class="keyword">sig</span> ...
78 <span class="keyword">end</span>
79 </span>
80 </code>
81 </div><div class="spec-doc"><p>Doc.</p></div>
82 </div>
83 </div>
84 </body>
85</html>