From: "Ian Zimmerman" <nobrowser@gmail.com>
To: caml-list@yquem.inria.fr
Subject: annotating nested modules with ocamldoc
Date: Sat, 6 Jan 2007 10:22:07 -0500 [thread overview]
Message-ID: <17af13780701060722h363d2a2ep9defb458ecb17ab2@mail.gmail.com> (raw)
Given the following files:
(* Foo.mli *)
module type BOO = sig
(** workaround: put documentation here *)
val boo : int -> int
end
module Boo : BOO
(* Foo.mli ends *)
(* Foo.ml *)
let internal_goo i = i + 1
module type BOO = sig
val boo : int -> int
end
module Boo : BOO = struct
let boo i = internal_goo (i + 1)
end
(* Foo.ml ends *)
how do I produce an ocamldoc set *with* Foo.Boo.boo but *without*
Foo.internal_goo ?
So far, the only way I've found is to only process the mli file with
ocamldoc and attach an annotation in the signature in the indicated
place, but that is awkward when I want to make a cross-reference (I
have to reference the signature instead of the structure). The
problem is that when processing a ml file, the granularity of what is
included is one of two extremes: either everything, or just stuff
that's declared in the corresponding mli file, and the latter by
definition excludes members of modules :-(
next reply other threads:[~2007-01-06 15:22 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-01-06 15:22 Ian Zimmerman [this message]
2007-01-06 15:37 ` [Caml-list] " Philippe Wang
2007-01-06 15:57 ` Ian Zimmerman
2007-01-06 16:07 ` Philippe Wang
2007-01-06 16:12 ` Daniel Bünzli
2007-01-06 16:38 ` Ian Zimmerman
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=17af13780701060722h363d2a2ep9defb458ecb17ab2@mail.gmail.com \
--to=nobrowser@gmail.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