Version française
Home     About     Download     Resources     Contact us    

This site is updated infrequently. For up-to-date information, please visit the new OCaml website at

Browse thread
File inclusion with Ocamldoc
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: 2008-10-15 (15:06)
From: Nicolas Pouillard <nicolas.pouillard@g...>
Subject: Re: [Caml-list] File inclusion with Ocamldoc
Excerpts from Dario Teixeira's message of Wed Oct 15 16:43:32 +0200 2008:
> Hi,
> > It works for me with the 3.10.1. I just tried to write a
> > file, and a file truc.odocl with "Test" in it, and then
> > ran ocamlbuild :
> >     ocamlbuild truc.docdic/index.html
> > And it worked. Or maybe I didn't understand what you want?
> You're right.  I took the Ocamlbuild manual at face value, since
> it states it cannot handle implementation files.  Nevertheless,
> I'm still running into some problems with Ocamlbuild+Ocamldoc.
> First, while Ocamldoc will by default merge the comments from .ml
> and .mli files (with precedence given to the .mli file, unless
> -inv-merge-ml-mli is given), when I use Ocamlbuild to generate
> the documentation I notice the following pattern: if only the .ml
> file is present then it's used for generating the documentation;
> If, however, both .ml and .mli are present, then only the .mli
> is taken into account (no merging is done).  Second, how does one
> tell Ocamlbuild to include .txt files in the documentation?

The manual states that implementation files are not handled because if you
have a .ml and .mli then ocamlbuild will choose the .mli.

Nicolas Pouillard aka Ertai