Version française
Home     About     Download     Resources     Contact us    
Browse thread
ocamlbuild: generating documentation
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: Nicolas Pouillard <nicolas.pouillard@g...>
Subject: Re: [Caml-list] ocamlbuild: generating documentation
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. In the
CVS version ml files are used when no mli can be built.

> 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.

> 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.

-- 
Nicolas Pouillard aka Ertai