ocaml-odoc/README.md

ocaml-odoc

This package contains odoc, a documentation generator for OCaml and Reason. It reads doc comments, delimited with (** ... *), and outputs HTML. Text inside doc comments is marked up in ocamldoc syntax.

Odoc's main advantage over ocamldoc is an accurate cross-referencer, which handles the complexity of the OCaml module system. Odoc also offers a good opportunity to improve HTML output compared to ocamldoc, but this is very much a work in progress.