Skip to content

Commit 23d0789

Browse files
JulowJulow
committed
test: Add example with comment vs preamble
1 parent db6d516 commit 23d0789

File tree

2 files changed

+77
-0
lines changed
  • test/xref2/include_module_type_of_preamble.t

2 files changed

+77
-0
lines changed

‎test/xref2/include_module_type_of_preamble.t/bar.ml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
11
include Foo
2+
3+
module P = struct
4+
(** Preamble for P. *)
5+
end
6+
7+
(** Outside preamble for Q. *)
8+
module Q = struct
9+
(** Inside preamble for Q. *)
10+
end

‎test/xref2/include_module_type_of_preamble.t/run.t‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,74 @@ Bar doesn't contain "Preamble for Foo" on purpose.
9292
</div>
9393
</details>
9494
</div>
95+
<div class="odoc-spec">
96+
<div class="spec module anchored" id="module-P">
97+
<a href="#module-P" class="anchor"></a>
98+
<code>
99+
<span><span class="keyword">module</span> <a href="P/index.html">P</a>
100+
</span>
101+
<span> : <span class="keyword">sig</span> ...
102+
<span class="keyword">end</span>
103+
</span>
104+
</code>
105+
</div><div class="spec-doc"><p>Preamble for P.</p></div>
106+
</div>
107+
<div class="odoc-spec">
108+
<div class="spec module anchored" id="module-Q">
109+
<a href="#module-Q" class="anchor"></a>
110+
<code>
111+
<span><span class="keyword">module</span> <a href="Q/index.html">Q</a>
112+
</span>
113+
<span> : <span class="keyword">sig</span> ...
114+
<span class="keyword">end</span>
115+
</span>
116+
</code>
117+
</div><div class="spec-doc"><p>Outside preamble for Q.</p></div>
118+
</div>
95119
</div>
96120
</body>
97121
</html>
122+
123+
Check the preambles:
124+
125+
$ cat html/test/Bar/Q/index.html
126+
<!DOCTYPE html>
127+
<html xmlns="http://www.w3.org/1999/xhtml">
128+
<head><title>Q (test.Bar.Q)</title><meta charset="utf-8"/>
129+
<link rel="stylesheet" href="../../../odoc.css"/>
130+
<meta name="generator" content="odoc %%VERSION%%"/>
131+
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
132+
<script src="../../../highlight.pack.js"></script>
133+
<script>hljs.initHighlightingOnLoad();</script>
134+
</head>
135+
<body class="odoc">
136+
<nav class="odoc-nav"><a href="../index.html">Up</a> –
137+
<a href="../../index.html">test</a> &#x00BB;
138+
<a href="../index.html">Bar</a> &#x00BB; Q
139+
</nav>
140+
<header class="odoc-preamble">
141+
<h1>Module <code><span>Bar.Q</span></code></h1>
142+
<p>Outside preamble for Q.</p><p>Inside preamble for Q.</p>
143+
</header><div class="odoc-content"></div>
144+
</body>
145+
</html>
146+
$ cat html/test/Bar/P/index.html
147+
<!DOCTYPE html>
148+
<html xmlns="http://www.w3.org/1999/xhtml">
149+
<head><title>P (test.Bar.P)</title><meta charset="utf-8"/>
150+
<link rel="stylesheet" href="../../../odoc.css"/>
151+
<meta name="generator" content="odoc %%VERSION%%"/>
152+
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
153+
<script src="../../../highlight.pack.js"></script>
154+
<script>hljs.initHighlightingOnLoad();</script>
155+
</head>
156+
<body class="odoc">
157+
<nav class="odoc-nav"><a href="../index.html">Up</a> –
158+
<a href="../../index.html">test</a> &#x00BB;
159+
<a href="../index.html">Bar</a> &#x00BB; P
160+
</nav>
161+
<header class="odoc-preamble">
162+
<h1>Module <code><span>Bar.P</span></code></h1><p>Preamble for P.</p>
163+
</header><div class="odoc-content"></div>
164+
</body>
165+
</html>

0 commit comments

Comments
 (0)