Go to file
Jerry James 78644af477 Rebuild for ocaml-cmdliner 1.1.1. 2022-09-20 11:44:14 -06:00
.gitignore Initial import. 2020-01-14 09:17:20 -07:00
README.md Version 2.1.0. 2022-02-09 09:36:31 -07:00
ocaml-odoc.spec Rebuild for ocaml-cmdliner 1.1.1. 2022-09-20 11:44:14 -06:00
sources Version 2.1.1. 2022-08-02 17:11:43 -06:00

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.