On Wed, 4 Apr 2007, Manuel Preliteiro wrote:
> I would like to know witch is the best documentation generator for OCaml so
> that in the end I can have something looked alike the C programing
> documentation.
Well, I have no idea what you mean by teh C programming documentation, but
the two documentation generators I use are ocamldoc and ocamlweb.
OCamldoc is part of the OCaml distribution and is fairly easy to use, but
it produces iffy content, in my opinion (at least most people seem to use
it to broduce iffy content with not enough description). You can see a
sample of its HTML output at
<http://gallium.inria.fr/~pouillar/ocamlbuild/html/index.html>.
OCamlweb (available at <http://www.lri.fr/~filliatr/ocamlweb/>;) is nicer
in that it allows you to embed LaTeX in your program and extract the
documentation from it. The downside is that if you convert it to HTML via
HeVeA or similar, you don't get the nice cross linking, but rather an
index with entries linked to the section they appear in.
William D. Neumann
---
"There's just so many extra children, we could just feed the
children to these tigers. We don't need them, we're not doing
anything with them.
Tigers are noble and sleek; children are loud and messy."
-- Neko Case
Life is unfair. Kill yourself or get over it.
-- Black Box Recorder
.
