From: Julien Signoles <Julien.Signoles@lri.fr>
To: David Teller <David.Teller@univ-orleans.fr>
Cc: OCaml <caml-list@inria.fr>
Subject: Re: [Caml-list] Documenting submodules ?
Date: Mon, 5 May 2008 10:11:04 +0200 (CEST) [thread overview]
Message-ID: <Pine.LNX.4.63.0805051008080.16412@serveur9-10.lri.fr> (raw)
In-Reply-To: <1209593864.6823.36.camel@Blefuscu>
> 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.
Usually ocamldoc works fine with submodule:
===== sub.ml
(** This is {!A}. It contains a properly-documented submodule {!A.B} and a
single value {!A.a}. *)
module A = struct
(** This is {!B}. It contains a single value {!B.b}. *)
module B = struct let b = 1 end
let a = 0
end
=====
$ ocamldoc -version
Ocamldoc 3.10.1
$ ocamldoc -html sub.ml
Hope this helps,
Julien Signoles
next prev parent reply other threads:[~2008-05-05 8:11 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 ` [Caml-list] " Arnaud Spiwack
2008-05-05 8:11 ` Julien Signoles [this message]
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=Pine.LNX.4.63.0805051008080.16412@serveur9-10.lri.fr \
--to=julien.signoles@lri.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).