Browse thread
ocamlbuild: generating documentation
[
Home
]
[ Index:
by date
|
by threads
]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
| Date: | -- (:) |
| From: | Hugo Ferreira <hmf@i...> |
| Subject: | Re: [Caml-list] ocamlbuild: generating documentation |
Hi, Nicolas Pouillard wrote: > Excerpts from hmf's message of Wed Nov 21 15:41:12 +0100 2007: >> Hello, > Hello, > >> I am attempting to use the document generation option provided by >> ocamlbuild. The manual states that ocamlbuild will "collect all the >> documentation for the interfaces (which will be built if necessary"). >> >> Questions: >> 1. How can I change this so that both *.ml and *.mli file are be used? > > If I well remember in OCaml-3.10.0 only mli files are took in account. Yes, my tests shows this. > In the CVS version ml files are used when no mli can be built. > What do you mean "can't be built"? I assume you can always generate a *.mli given *.ml, correct? Are you referring to other types of sources such as *.mly? Can the behaviour be changed? If I am not mistaken ocamldoc can merge *.ml and *.mli files so I think it may be easy enough to allow this. >> 2. Must I compile the files prior to invoking "ocamlbuild >> all.docdir/index.html" at any point? > > No it must works nicely without any pre-compilation. > Ok. >> On a different issue, the manual refers to "packing subdirectories >> into modules"... >> >> 1. Are we talking about indicating a path here, for example: >> >> cat all.odocl >> src/mod/Mod >> >> So that Mod is documented? > > No it's not related. > > Packing subdirectories is about using -pack to nest modules into one big > module. The "subdirectories" here is perhaps misleading but that's because > most of the time packages are used to reflect the directory hierarchy into > modules. > Ok. Understood. Thank you for such prompt replies. Regards, Hugo F.