Skip to content

Commit 8ae78e6

Browse files
panglesdjonludlam
panglesd
authored and
jonludlam
committed
Adding tests and changelog entry
Signed-off-by: Paul-Elliot <peada@free.fr>
1 parent 868dbb8 commit 8ae78e6

12 files changed

+184
-5
lines changed

‎CHANGES.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Bugs fixed
55
- Fix a missing Result constructor during compile. This will cause some
66
functor arguments to have different filenames (@jonludlam, #795)
77

8+
Additions
9+
- Handle comments attached to open statement as floating comment, instead
10+
of dropping them (@panglesd, #797)
11+
812
2.0.2
913
-----
1014

‎test/generators/cases/toplevel_comments.mli

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,16 @@ module Ref_in_synopsis : sig
7979

8080
type t
8181
end
82+
83+
module Comments_on_open : sig
84+
module M : sig
85+
type t
86+
end
87+
88+
open M
89+
(**
90+
{2:sec Section}
91+
92+
Comments attached to open are treated as floating comments.
93+
Referencing {!section-sec} {!M.t} works *)
94+
end

‎test/generators/html/Toplevel_comments-Comments_on_open-M.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head><title>M (Toplevel_comments.Comments_on_open.M)</title>
4+
<link rel="stylesheet" href="odoc.css"/><meta charset="utf-8"/>
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">
12+
<a href="Toplevel_comments-Comments_on_open.html">Up</a> –
13+
<a href="Toplevel_comments.html">Toplevel_comments</a> &#x00BB;
14+
<a href="Toplevel_comments-Comments_on_open.html">Comments_on_open</a>
15+
&#x00BB; M
16+
</nav>
17+
<header class="odoc-preamble">
18+
<h1>Module <code><span>Comments_on_open.M</span></code></h1>
19+
</header>
20+
<div class="odoc-content">
21+
<div class="odoc-spec">
22+
<div class="spec type" id="type-t" class="anchored">
23+
<a href="#type-t" class="anchor"></a>
24+
<code><span><span class="keyword">type</span> t</span></code>
25+
</div>
26+
</div>
27+
</div>
28+
</body>
29+
</html>

‎test/generators/html/Toplevel_comments-Comments_on_open.html

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head><title>Comments_on_open (Toplevel_comments.Comments_on_open)</title>
4+
<link rel="stylesheet" href="odoc.css"/><meta charset="utf-8"/>
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="Toplevel_comments.html">Up</a> –
12+
<a href="Toplevel_comments.html">Toplevel_comments</a> &#x00BB;
13+
Comments_on_open
14+
</nav>
15+
<header class="odoc-preamble">
16+
<h1>Module <code><span>Toplevel_comments.Comments_on_open</span></code>
17+
</h1>
18+
</header>
19+
<nav class="odoc-toc"><ul><li><a href="#sec">Section</a></li></ul></nav>
20+
<div class="odoc-content">
21+
<div class="odoc-spec">
22+
<div class="spec module" id="module-M" class="anchored">
23+
<a href="#module-M" class="anchor"></a>
24+
<code>
25+
<span><span class="keyword">module</span>
26+
<a href="Toplevel_comments-Comments_on_open-M.html">M</a>
27+
</span>
28+
<span> : <span class="keyword">sig</span> ...
29+
<span class="keyword">end</span>
30+
</span>
31+
</code>
32+
</div>
33+
</div><h3 id="sec"><a href="#sec" class="anchor"></a>Section</h3>
34+
<p>Comments attached to open are treated as floating comments. Referencing
35+
<a href="#sec">Section</a>
36+
<a href="Toplevel_comments-Comments_on_open-M.html#type-t">
37+
<code>M.t</code>
38+
</a> works
39+
</p>
40+
</div>
41+
</body>
42+
</html>

‎test/generators/html/Toplevel_comments.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,19 @@ <h1>Module <code><span>Toplevel_comments</span></code></h1>
199199
</p>
200200
</div>
201201
</div>
202+
<div class="odoc-spec">
203+
<div class="spec module" id="module-Comments_on_open" class="anchored">
204+
<a href="#module-Comments_on_open" class="anchor"></a>
205+
<code>
206+
<span><span class="keyword">module</span>
207+
<a href="Toplevel_comments-Comments_on_open.html">Comments_on_open</a>
208+
</span>
209+
<span> : <span class="keyword">sig</span> ...
210+
<span class="keyword">end</span>
211+
</span>
212+
</code>
213+
</div>
214+
</div>
202215
</div>
203216
</body>
204217
</html>

‎test/generators/html/toplevel_comments.targets

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ Toplevel_comments-class-c1.html
1212
Toplevel_comments-class-type-ct.html
1313
Toplevel_comments-class-c2.html
1414
Toplevel_comments-Ref_in_synopsis.html
15+
Toplevel_comments-Comments_on_open.html
16+
Toplevel_comments-Comments_on_open-M.html

‎test/generators/latex/Toplevel_comments.tex

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ \section{Module \ocamlinlinecode{Toplevel\_\allowbreak{}comments}}\label{module-
4343
\end{ocamlindent}%
4444
\ocamlcodefragment{\ocamltag{keyword}{end}}\begin{ocamlindent}\hyperref[module-Toplevel+u+comments-module-Ref+u+in+u+synopsis-type-t]{\ocamlinlinecode{\ocamlinlinecode{t}}[p\pageref*{module-Toplevel+u+comments-module-Ref+u+in+u+synopsis-type-t}]}.\end{ocamlindent}%
4545
\medbreak
46+
\label{module-Toplevel+u+comments-module-Comments+u+on+u+open}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[module-Toplevel+u+comments-module-Comments+u+on+u+open]{\ocamlinlinecode{Comments\_\allowbreak{}on\_\allowbreak{}open}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{module-Toplevel+u+comments-module-Comments+u+on+u+open-module-M}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[module-Toplevel+u+comments-module-Comments+u+on+u+open-module-M]{\ocamlinlinecode{M}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\label{module-Toplevel+u+comments-module-Comments+u+on+u+open-module-M-type-t}\ocamlcodefragment{\ocamltag{keyword}{type} t}\\
47+
\end{ocamlindent}%
48+
\ocamlcodefragment{\ocamltag{keyword}{end}}\\
49+
\subsubsection{Section\label{sec}}%
50+
Comments attached to open are treated as floating comments. Referencing \hyperref[module-Toplevel+u+comments-module-Comments+u+on+u+open-sec]{\ocamlinlinecode{Section}[p\pageref*{module-Toplevel+u+comments-module-Comments+u+on+u+open-sec}]} \hyperref[module-Toplevel+u+comments-module-Comments+u+on+u+open-module-M-type-t]{\ocamlinlinecode{\ocamlinlinecode{M.\allowbreak{}t}}[p\pageref*{module-Toplevel+u+comments-module-Comments+u+on+u+open-module-M-type-t}]} works
51+
52+
\end{ocamlindent}%
53+
\ocamlcodefragment{\ocamltag{keyword}{end}}\\
4654

4755
\input{Toplevel_comments.Alias.tex}
4856
\input{Toplevel_comments.c1.tex}

‎test/generators/link.dune.inc

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6161,7 +6161,9 @@
61616161
Toplevel_comments-class-c1.html.gen
61626162
Toplevel_comments-class-type-ct.html.gen
61636163
Toplevel_comments-class-c2.html.gen
6164-
Toplevel_comments-Ref_in_synopsis.html.gen)
6164+
Toplevel_comments-Ref_in_synopsis.html.gen
6165+
Toplevel_comments-Comments_on_open.html.gen
6166+
Toplevel_comments-Comments_on_open-M.html.gen)
61656167
(action
61666168
(run
61676169
odoc
@@ -6242,7 +6244,19 @@
62426244
(action
62436245
(diff
62446246
Toplevel_comments-Ref_in_synopsis.html
6245-
Toplevel_comments-Ref_in_synopsis.html.gen))))
6247+
Toplevel_comments-Ref_in_synopsis.html.gen)))
6248+
(rule
6249+
(alias runtest)
6250+
(action
6251+
(diff
6252+
Toplevel_comments-Comments_on_open.html
6253+
Toplevel_comments-Comments_on_open.html.gen)))
6254+
(rule
6255+
(alias runtest)
6256+
(action
6257+
(diff
6258+
Toplevel_comments-Comments_on_open-M.html
6259+
Toplevel_comments-Comments_on_open-M.html.gen))))
62466260

62476261
(subdir
62486262
html
@@ -6315,7 +6329,9 @@
63156329
Toplevel_comments.Alias.3o.gen
63166330
Toplevel_comments.c1.3o.gen
63176331
Toplevel_comments.c2.3o.gen
6318-
Toplevel_comments.Ref_in_synopsis.3o.gen)
6332+
Toplevel_comments.Ref_in_synopsis.3o.gen
6333+
Toplevel_comments.Comments_on_open.3o.gen
6334+
Toplevel_comments.Comments_on_open.M.3o.gen)
63196335
(action
63206336
(run
63216337
odoc
@@ -6370,7 +6386,19 @@
63706386
(action
63716387
(diff
63726388
Toplevel_comments.Ref_in_synopsis.3o
6373-
Toplevel_comments.Ref_in_synopsis.3o.gen))))
6389+
Toplevel_comments.Ref_in_synopsis.3o.gen)))
6390+
(rule
6391+
(alias runtest)
6392+
(action
6393+
(diff
6394+
Toplevel_comments.Comments_on_open.3o
6395+
Toplevel_comments.Comments_on_open.3o.gen)))
6396+
(rule
6397+
(alias runtest)
6398+
(action
6399+
(diff
6400+
Toplevel_comments.Comments_on_open.M.3o
6401+
Toplevel_comments.Comments_on_open.M.3o.gen))))
63746402

63756403
(subdir
63766404
man

‎test/generators/man/Toplevel_comments.3o

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,4 +119,5 @@ Doc of c2\.
119119
.ti +2
120120
\f[CI]t\fR\.
121121
.nf
122-
122+
.sp
123+
\f[CB]module\fR Comments_on_open : \f[CB]sig\fR \.\.\. \f[CB]end\fR

‎test/generators/man/Toplevel_comments.Comments_on_open.3o

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
.TH Comments_on_open 3 "" "Odoc" "OCaml Library"
3+
.SH Name
4+
Toplevel_comments\.Comments_on_open
5+
.SH Synopsis
6+
.sp
7+
.in 2
8+
\fBModule Toplevel_comments\.Comments_on_open\fR
9+
.in
10+
.sp
11+
.SH Documentation
12+
.sp
13+
.nf
14+
\f[CB]module\fR M : \f[CB]sig\fR \.\.\. \f[CB]end\fR
15+
.sp
16+
.in 4
17+
\fB1\.1 Section\fR
18+
.in
19+
.sp
20+
.fi
21+
Comments attached to open are treated as floating comments\. Referencing \f[CI]Section\fR \f[CI]M\.t\fR works
22+
.nf
23+

0 commit comments

Comments
 (0)