summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoroctachron <octa@polychoron.fr>2017-02-18 14:34:09 +0100
committeroctachron <octa@polychoron.fr>2017-07-31 23:53:35 +0200
commit3bf7f9f6228ce7024d1d8b5ff5706129d5a78eec (patch)
tree2754398447aeb8147f912b42145941a94545cd4a
parente5f94ee9d4e1e328df5eea2ae04b500612c08a03 (diff)
downloadocaml-3bf7f9f6228ce7024d1d8b5ff5706129d5a78eec.tar.gz
Update GPR#1037 changes
-rw-r--r--Changes11
-rw-r--r--testsuite/tests/tool-ocamldoc-html/No_preamble.reference4
2 files changed, 10 insertions, 5 deletions
diff --git a/Changes b/Changes
index 90e02254b5..bc0bf0cf70 100644
--- a/Changes
+++ b/Changes
@@ -188,6 +188,13 @@ Working version
* MPR#7352,PR#7353: ocamldoc, better paragraphs in html output
(Florian Angeletti, request by Daniel Bünzli)
+
+* MPR#7478, GPR#1037: ocamldoc, do not use as a module preamble documentation
+ comments that occur after the first module element. This change may break
+ existing documenation. In particular, module preambles must now come before
+ any `open` statement.
+ (Florian Angeletti, review by David Allsopp and report by Daniel Bünzli)
+
- MPR#7521, GPR#1159: ocamldoc, end generated latex file with a new line
(Florian Angeletti)
@@ -706,10 +713,6 @@ OCaml 4.05.0 (13 Jul 2017):
a short description in overviews.
(Florian Angeletti)
-- PR#7478, GPR#1037: ocamldoc, do not use as a module preamble documentation
- comments that occur after the first module element
- (Florian Angeletti, report by Daniel Bünzli)
-
- GPR#848: ocamldoc, escape link targets in HTML output
(Etienne Millon, review by Gabriel Scherer, Florian Angeletti and
Daniel Bünzli)
diff --git a/testsuite/tests/tool-ocamldoc-html/No_preamble.reference b/testsuite/tests/tool-ocamldoc-html/No_preamble.reference
index 48aaf4bee2..a244800bfe 100644
--- a/testsuite/tests/tool-ocamldoc-html/No_preamble.reference
+++ b/testsuite/tests/tool-ocamldoc-html/No_preamble.reference
@@ -18,6 +18,8 @@
<pre><span class="keyword">module</span> No_preamble: <code class="code"><span class="keyword">sig</span></code> <a href="No_preamble.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><hr width="100%">
<pre><span id="VALx"><span class="keyword">val</span> x</span> : <code class="type">unit</code></pre><div class="info ">
-This is a documentation comment for <code class="code">x</code>, not a module preamble.<br>
+<div class="info-desc">
+<p>This is a documentation comment for <code class="code">x</code>, not a module preamble.</p>
+</div>
</div>
</body></html> \ No newline at end of file