File: Stop.html

package info (click to toggle)
ocaml-odoc 2.1.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,744 kB
  • sloc: ml: 37,049; makefile: 124; sh: 79
file content (52 lines) | stat: -rw-r--r-- 2,154 bytes parent folder | download
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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
 <head><title>Stop (Stop)</title><link rel="stylesheet" href="odoc.css"/>
  <meta charset="utf-8"/><meta name="generator" content="odoc 2.1.1"/>
  <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
  <script src="highlight.pack.js"></script>
  <script>hljs.initHighlightingOnLoad();</script>
 </head>
 <body class="odoc">
  <header class="odoc-preamble">
   <h1>Module <code><span>Stop</span></code></h1>
   <p>This test cases exercises stop comments.</p>
  </header>
  <div class="odoc-content">
   <div class="odoc-spec">
    <div class="spec value" id="val-foo" class="anchored">
     <a href="#val-foo" class="anchor"></a>
     <code><span><span class="keyword">val</span> foo : int</span></code>
    </div><div class="spec-doc"><p>This is normal commented text.</p></div>
   </div>
   <p>The next value is <code>bar</code>, and it should be missing from
     the documentation. There is also an entire module, <code>M</code>
    , which should also be hidden. It contains a nested stop comment,
     but that stop comment should not turn documentation back on in this
     outer module, because stop comments respect scope.
   </p><p>Documentation is on again.</p>
   <p>Now, we have a nested module, and it has a stop comment between
     its two items. We want to see that the first item is displayed, 
    but the second is missing, and the stop comment disables documenation
     only in that module, and not in this outer module.
   </p>
   <div class="odoc-spec">
    <div class="spec module" id="module-N" class="anchored">
     <a href="#module-N" class="anchor"></a>
     <code>
      <span><span class="keyword">module</span> <a href="Stop-N.html">N</a>
      </span>
      <span> : <span class="keyword">sig</span> ... 
       <span class="keyword">end</span>
      </span>
     </code>
    </div>
   </div>
   <div class="odoc-spec">
    <div class="spec value" id="val-lol" class="anchored">
     <a href="#val-lol" class="anchor"></a>
     <code><span><span class="keyword">val</span> lol : int</span></code>
    </div>
   </div>
  </div>
 </body>
</html>