ocamlformat icon indicating copy to clipboard operation
ocamlformat copied to clipboard

How to wrap documentation comments?

Open Hirrolot opened this issue 2 months ago • 0 comments

I'm seeing the option wrap-comments, but when set to true, it doesn't wrap documentation comments (only regular comments). Is there any way to wrap documentation comments?

From doc/manpage_ocamlformat.mld:

       --wrap-comments
           Wrap comments and docstrings. Comments and docstrings are divided
           into paragraphs by open lines (two or more consecutive newlines),
           and each paragraph is wrapped at the margin. Multi-line comments
           with vertically-aligned asterisks on the left margin are not
           wrapped. Consecutive comments with both left and right margin
           aligned are not wrapped either. The flag is unset by default.

Hirrolot avatar Apr 27 '24 17:04 Hirrolot