|
 |
cd641b5 |
# ocaml-odoc
|
|
|
cd641b5 |
|
|
 |
ee2f770 |
This package contains [odoc](https://github.com/ocaml/odoc), a documentation
|
|
|
ee2f770 |
generator for [OCaml](https://ocaml.org/) and
|
|
|
ee2f770 |
[Reason](https://reasonml.github.io/). It reads doc comments, delimited with
|
|
|
ee2f770 |
`(** ... *)`, and outputs HTML. Text inside doc comments is marked up in
|
|
|
ee2f770 |
[ocamldoc syntax](https://ocaml.org/manual/ocamldoc.html).
|
|
|
ee2f770 |
|
|
|
ee2f770 |
Odoc's main advantage over ocamldoc is an accurate cross-referencer, which
|
|
|
ee2f770 |
handles the complexity of the OCaml module system. Odoc also offers a good
|
|
|
ee2f770 |
opportunity to improve HTML output compared to ocamldoc, but this is very much
|
|
|
ee2f770 |
a work in progress.
|