caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Arnaud Spiwack <Arnaud.Spiwack@lix.polytechnique.fr>
To: David Teller <David.Teller@univ-orleans.fr>
Cc: OCaml <caml-list@inria.fr>
Subject: Re: [Caml-list] Documenting submodules ?
Date: Thu, 01 May 2008 21:51:59 +0200	[thread overview]
Message-ID: <481A1F5F.2040004@lix.polytechnique.fr> (raw)
In-Reply-To: <1209593864.6823.36.camel@Blefuscu>

As far as I'm aware, the HTML output of ocamldoc documents submodules as 
hyperlinks. By clicking on them you then get to a documentation of the 
submodule itself. This is already something.


Arnaud Spiwack

David Teller a écrit :
>    Dear list,
>
> As mentioned previously, I'm working on a derivative of ExtLib
> (promised, I'll submit the changes within a few days). I've put together
> most of the features I want for now, but I'm faced with a problem of
> documentation. Essentially, I have a few big modules containing each a
> few smaller modules -- each smaller module being defined in one file. 
>
> When invoking ocamldoc, either directly or through ocamlbuild + .odocl,
> the generated documentation only contains the name of modules, without
> any of the comments or even the values.
>
> Is there any ocamldoc plug-in or ocamlbuild plug-in or anything else
> that could help me document my code without having to rewrite everything
> and/or to copy and paste thousands of lines of .mli ?
>
> Cheers,
>  David
>
>   


  reply	other threads:[~2008-05-01 19:52 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-04-30 22:17 David Teller
2008-05-01 19:51 ` Arnaud Spiwack [this message]
2008-05-05  8:11 ` [Caml-list] " Julien Signoles
2008-05-05  8:22   ` David Teller
2008-05-05  8:35     ` Maxence Guesdon
2008-05-05  9:12       ` David Teller
2008-05-05  9:48         ` 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=481A1F5F.2040004@lix.polytechnique.fr \
    --to=arnaud.spiwack@lix.polytechnique.fr \
    --cc=David.Teller@univ-orleans.fr \
    --cc=caml-list@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).