ocaml-odoc/README.md
Jerry James ee2f770464 Version 2.1.0.
- License is ISC, not MIT.
- Trim BuildRequires.
2022-02-09 09:36:31 -07:00

599 B

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.