13 lines
599 B
Markdown
13 lines
599 B
Markdown
# ocaml-odoc
|
|
|
|
This package contains [odoc](https://github.com/ocaml/odoc), a documentation
|
|
generator for [OCaml](https://ocaml.org/) and
|
|
[Reason](https://reasonml.github.io/). It reads doc comments, delimited with
|
|
`(** ... *)`, and outputs HTML. Text inside doc comments is marked up in
|
|
[ocamldoc syntax](https://ocaml.org/manual/ocamldoc.html).
|
|
|
|
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.
|