Version française
Home     About     Download     Resources     Contact us    
Browse thread
Two questions on OCamlDoc
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: Maxence Guesdon <maxence.guesdon@i...>
Subject: Re: [Caml-list] Another question on OcamlDoc
On Tue, 02 Sep 2008 14:48:50 +0200
Jan Kybic <kybic@fel.cvut.cz> wrote:

> > And while I'm asking complex questions, can anyone think of a way of
> > asking OCamlDoc to resolve [string] to [String.t], ['a list] to ['a
> > List.t], ['a array] to ['a Array.t], etc?
> 
> Let me add another couple of questions about OcamlDoc. I am sorry if
> this is a common knowledge.
> 
>    - how can I tell OcamlDoc to only process some files?
>      Actually, the question is rather how to make OcamlDoc ignore the
>      unresolved dependencies and "Unbound type constructor" errors.

Does it stop ocamldoc or does is end in elements not linked in the final
doc ?
If it stops ocamldoc, then this is a compilation problem. Make sure you
give the same options (-I, -rectypes, ...) to ocamldoc than to ocamlc.
In th second case, you can use the -hide-warnings option.
> 
>      [Sometimes it is as if OcamlDoc and Ocaml did not parse the files
>      in the same way - a program which compiles with ocamlopt gives me 
>      "Unbound type constructor errors" with ocamldoc. I will try to
>      reduce my code into a simple case to post it here later.]
> 
>    - how can I tell OcamlDoc to run a preprocessor on the file first?
>      (I am using ocaml+twt)

Use the -pp option of ocamldoc, which works the same way as for ocamlc.

Regards,

Maxence


-- 
Maxence Guesdon                           http://yquem.inria.fr/~guesdon/
Service Expérimentation et Développements https://devel.inria.fr/rocq/
INRIA Paris-Rocquencourt                  http://www.inria.fr/rocquencourt/