diff options
author | Damien Doligez <damien.doligez@gmail.com> | 2016-06-21 14:04:20 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-06-21 14:04:20 +0200 |
commit | 4063cb317a70e80da8498f58948111afcea09c77 (patch) | |
tree | 7c1c03ef9a21c3dae2302aae92d8443a36dc285e /manual | |
parent | a8c03709281c52e4633f8a5021f453de9265957a (diff) | |
parent | 61e8b63e166eea934785641208c86efbd84421a1 (diff) | |
download | ocaml-4063cb317a70e80da8498f58948111afcea09c77.tar.gz |
Merge pull request #548 from Octachron/empty_docstring
Empty documentation comment (**)
Diffstat (limited to 'manual')
-rw-r--r-- | manual/manual/refman/exten.etex | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/manual/manual/refman/exten.etex b/manual/manual/refman/exten.etex index a7c8da2921..f454b4c738 100644 --- a/manual/manual/refman/exten.etex +++ b/manual/manual/refman/exten.etex @@ -2363,3 +2363,19 @@ will be converted to: type t = T of string [@ocaml.doc " Attaches to T not t "] [@@ocaml.doc " Attaches to t "] \end{verbatim} + +In the absence of meaningful comment on the last constructor of +a type, an empty comment~"(**)" can be used instead: + +\begin{verbatim} +type t = T of string +(**) +(** Attaches to t *) +\end{verbatim} + +will be converted directly to + +\begin{verbatim} +type t = T of string +[@@ocaml.doc " Attaches to t "] +\end{verbatim} |