File tree Expand file tree Collapse file tree 4 files changed +4
-16
lines changed
test_package+ml/Include2/Y_include_synopsis
test_package+re/Include2/Y_include_synopsis
latex/expect/test_package+ml Expand file tree Collapse file tree 4 files changed +4
-16
lines changed Original file line number Diff line number Diff line change @@ -1536,7 +1536,7 @@ module Make (Syntax : SYNTAX) = struct
1536
1536
| ModuleType mt -> umty mt
1537
1537
in
1538
1538
1539
- let sg_doc , content = signature t.expansion.content in
1539
+ let _ , content = signature t.expansion.content in
1540
1540
let summary =
1541
1541
O. render
1542
1542
(O. keyword " include" ++ O. txt " " ++ include_decl
@@ -1550,10 +1550,8 @@ module Make (Syntax : SYNTAX) = struct
1550
1550
declarations, which show only the synopsis. We can't only show the
1551
1551
synopsis because no page is generated to render it and we'd loose
1552
1552
the full documentation.
1553
- As an exception, the synopsis from the expansion is used iff there
1554
- is no documentation. *)
1555
- if t.doc <> [] then Comment. to_ir t.doc
1556
- else Comment. synopsis ~decl_doc: [] ~expansion_doc: (Some sg_doc)
1553
+ The documentation from the expansion is not used. *)
1554
+ Comment. to_ir t.doc
1557
1555
in
1558
1556
Item. Include { attr; anchor; doc; content }
1559
1557
end
Original file line number Diff line number Diff line change 27
27
</ header >
28
28
< div class ="odoc-content ">
29
29
< div class ="odoc-include ">
30
- < div class ="spec-doc ">
31
- < p >
32
- Top-comment of Y.
33
- </ p >
34
- </ div >
35
30
< details open ="open ">
36
31
< summary class ="spec include ">
37
32
< code > < span > < span class ="keyword "> include</ span > < span class ="keyword "> module</ span > < span class ="keyword "> type</ span > < span class ="keyword "> of</ span > < span class ="keyword "> struct</ span > < span class ="keyword "> include</ span > < a href ="../Y/index.html "> Y</ a > < span class ="keyword "> end</ span > </ span > </ code >
Original file line number Diff line number Diff line change 27
27
</ header >
28
28
< div class ="odoc-content ">
29
29
< div class ="odoc-include ">
30
- < div class ="spec-doc ">
31
- < p >
32
- Top-comment of Y.
33
- </ p >
34
- </ div >
35
30
< details open ="open ">
36
31
< summary class ="spec include ">
37
32
< code > < span > < span class ="keyword "> include</ span > < span class ="keyword "> module</ span > < span class ="keyword "> type</ span > < span class ="keyword "> of</ span > < span class ="keyword "> struct</ span > < span class ="keyword "> include</ span > < a href ="../Y/index.html "> Y</ a > < span class ="keyword "> end</ span > < span class ="keyword "> ;</ span > </ span > </ code >
Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ \section{Module \ocamlinlinecode{Include2}}\label{container-page-test+u+package+
10
10
\end {ocamlindent }%
11
11
\ocamlcodefragment {\ocamltag {keyword}{end}}\begin {ocamlindent }Top-comment of Y.\end {ocamlindent }%
12
12
\medbreak
13
- \label {container-page-test +u +package +++ml-module-Include2-module-Y +u +include +u +synopsis }\ocamlcodefragment {\ocamltag {keyword}{module} \hyperref [container-page-test+u+package+++ml-module-Include2-module-Y+u+include+u+synopsis]{\ocamlinlinecode {Y\_ \allowbreak {}include\_ \allowbreak {}synopsis}}}\ocamlcodefragment { : \ocamltag {keyword}{sig}}\begin {ocamlindent }Top-comment of Y. \ocamltag {keyword}{include} \ocamltag {keyword}{module} \ocamltag {keyword}{type} \ocamltag {keyword}{of} \ocamltag {keyword}{struct} \ocamltag {keyword}{include} \hyperref [container-page-test+u+package+++ml-module-Include2-module-Y]{\ocamlinlinecode {Y}} \ocamltag {keyword}{end}\label {container-page-test +u +package +++ml-module-Include2-module-Y +u +include +u +synopsis-type-t }\ocamlcodefragment {\ocamltag {keyword}{type} t = \hyperref [container-page-test+u+package+++ml-module-Include2-module-Y-type-t]{\ocamlinlinecode {Y.\allowbreak {}t}}}\\
13
+ \label {container-page-test +u +package +++ml-module-Include2-module-Y +u +include +u +synopsis }\ocamlcodefragment {\ocamltag {keyword}{module} \hyperref [container-page-test+u+package+++ml-module-Include2-module-Y+u+include+u+synopsis]{\ocamlinlinecode {Y\_ \allowbreak {}include\_ \allowbreak {}synopsis}}}\ocamlcodefragment { : \ocamltag {keyword}{sig}}\begin {ocamlindent }\ocamltag {keyword}{include} \ocamltag {keyword}{module} \ocamltag {keyword}{type} \ocamltag {keyword}{of} \ocamltag {keyword}{struct} \ocamltag {keyword}{include} \hyperref [container-page-test+u+package+++ml-module-Include2-module-Y]{\ocamlinlinecode {Y}} \ocamltag {keyword}{end}\label {container-page-test +u +package +++ml-module-Include2-module-Y +u +include +u +synopsis-type-t }\ocamlcodefragment {\ocamltag {keyword}{type} t = \hyperref [container-page-test+u+package+++ml-module-Include2-module-Y-type-t]{\ocamlinlinecode {Y.\allowbreak {}t}}}\\
14
14
\end {ocamlindent }%
15
15
\ocamlcodefragment {\ocamltag {keyword}{end}}\begin {ocamlindent }The \ocamlinlinecode {include Y} below should have the synopsis from \ocamlinlinecode {Y}'s top-comment attached to it.\end {ocamlindent }%
16
16
\medbreak
You can’t perform that action at this time.
0 commit comments