caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Dario Teixeira <darioteixeira@yahoo.com>
To: caml-list@yquem.inria.fr
Subject: Trouble with Ocamldoc + Ocamlbuild
Date: Fri, 27 Feb 2009 11:57:14 -0800 (PST)	[thread overview]
Message-ID: <481995.31517.qm@web111507.mail.gq1.yahoo.com> (raw)


Hi,

I'm having some trouble getting Ocamlbuild to produce API documentation via
Ocamldoc in a project that uses packed modules.  The project has two main
directories, modA and modB, each contanining a couple of modules, as follows:

modA
  |- Foo
  |- Bar

modB
  |- Glu
  |- Bah


I placed the modA.mlpack and modB.mlpack files at the top-level, listing the
modules in the respective directories.  The main target itself is to build
the library mylib.cma, containing the packed modules modA.cmo and modB.cmo.
Therefore, also at the top level directory is the file mylib.mllib, whose
contents are "modA" and "modB" in separate lines.

Now, building the library with "ocamlbuild mylib.cma" works fine.  But how
can I tell Ocamlbuild to build the API doc with Ocamldoc?  I reckon I have
to create a mylib.odocl file at the top-level, but what should its contents
be? I have tried "modA" and "modB", but it doesn't work.  Neither does a
fully qualified specification, such as "modA.Foo", etc.  Any thoughts?

Thanks in advance!
Best regards,
Dario Teixeira

P.S. The caml-list seems to be cloning posts today.  Sorry if you get this
     message multiple times.






             reply	other threads:[~2009-02-27 19:57 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-02-27 19:57 Dario Teixeira [this message]
2009-02-27 20:09 ` [Caml-list] " David Rajchenbach-Teller
2009-02-27 21:31   ` Dario Teixeira

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=481995.31517.qm@web111507.mail.gq1.yahoo.com \
    --to=darioteixeira@yahoo.com \
    --cc=caml-list@yquem.inria.fr \
    /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).