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 (08:54)
From: Romain Bardou <Romain.Bardou@l...>
Subject: Re: [Caml-list] File inclusion with Ocamldoc
>> You can use .txt files to do this. Simply type ocamldoc
>> comment  (without (** *)) in a file.txt file and pass it to
>> ocamldoc like any  .ml or .mli file. This will be considered
>> as a File module and you can refer to it by {!File} from any
>> ocamldoc comment.
> Excellent!  Thanks for the tip.  Incidentally, the 3.10 version
> of Ocamlbuild does not support the generation of documentation
> from implementation files.  Will 3.11 fix this?

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?

Romain Bardou