Doc-comment workflows for ocaml?

Ecosystem
, ,
1

I’m not sure where to ask this question, so I figured I’d ask it here. I’m trying to understand all the various doc-comment extraction tools that exist in the Ocaml world, and specifically the ones that are “common”/“popular”/“quasi-official”.

I know of ocamldoc, and have heard of odoc. Are there others?

Also, if I understand correctly, the way doc-comments get recognized by these tools, is that they are flagged specially by the standard ocaml parser, converted into attributes (“ocaml.text”, “ocaml.doc”). Digging thru the source of ocamldoc, I see that this is the case; would it be correct to assume that this is a general rule?

2

It’s not clear what “workflow” you are looking for.

If you are looking for a way to provide documentation for libraries that you publish on opam simply install the .cmti files for the API of your library. Something else will figure out.

3

Oh, nice! I was unaware that at this point, .cmti files contained everything necessary to drive doc-comment tools. Thank you!