caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Maxence Guesdon <maxence.guesdon@inria.fr>
To: Jan Kybic <kybic@fel.cvut.cz>
Cc: Caml <caml-list@yquem.inria.fr>
Subject: Re: [Caml-list] Another question on OcamlDoc
Date: Wed, 3 Sep 2008 08:48:50 +0200	[thread overview]
Message-ID: <20080903084850.22daa88d@alcazar.inria.fr> (raw)
In-Reply-To: <8763pe7lxp.fsf_-_@fel.cvut.cz>

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/




  parent reply	other threads:[~2008-09-03  6:42 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-09-02 11:47 Two questions on OCamlDoc David Teller
2008-09-02 12:05 ` [Caml-list] " David Teller
2008-09-02 12:48   ` Another question on OcamlDoc Jan Kybic
2008-09-02 17:19     ` [Caml-list] " David Teller
2008-09-03  6:48     ` Maxence Guesdon [this message]
2008-09-15 13:09       ` Jan Kybic
2008-09-02 13:37   ` [Caml-list] Two questions on OCamlDoc Maxence Guesdon
2008-09-02 13:12 ` Maxence Guesdon
2008-09-05 10:25 ` David Teller
2008-09-05 12:03   ` Maxence Guesdon
2008-09-05 12:33     ` David Teller
2008-09-05 12:37       ` Maxence Guesdon
2008-09-05 12:42         ` David Teller
2008-09-05 12:58           ` Maxence Guesdon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20080903084850.22daa88d@alcazar.inria.fr \
    --to=maxence.guesdon@inria.fr \
    --cc=caml-list@yquem.inria.fr \
    --cc=kybic@fel.cvut.cz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).