From: Maxence Guesdon <maxence.guesdon@inria.fr>
To: Richard Jones <rich@annexia.org>
Cc: Dustin Sallings <dustin@spy.net>, caml-list@inria.fr
Subject: Re: [Caml-list] non-exported functions
Date: Tue, 28 Oct 2003 22:10:48 +0100 [thread overview]
Message-ID: <20031028221048.733a71fe.maxence.guesdon@inria.fr> (raw)
In-Reply-To: <20031028210756.GA27347@redhat.com>
On Tue, 28 Oct 2003 21:07:57 +0000
Richard Jones <rich@annexia.org> wrote:
> On Tue, Oct 28, 2003 at 12:02:40PM -0800, Dustin Sallings wrote:
> >
> > I've got a module that contains a few helper functions that should
> > only be used internally. Is there a way to prevent them from being
> > exported and/or included in ocamldoc output?
>
> Define an .mli file for your module. Anything not listed explicitly in
> the .mli file won't be exported.
This works.
> In addition you can control what ocamldoc produces either by using (*
> vs (**, or by using various flags which are detailed in the ocamldoc
> manual.
This won't prevent the functions to appear in the doc output in they
are in the .mli.
You can use the (**/**) special comment to tell ocamldoc not to show
elements placed after this comment, in the current module, module type,
class or class-type.
--
Maxence Guesdon
-------------------
To unsubscribe, mail caml-list-request@inria.fr Archives: http://caml.inria.fr
Bug reports: http://caml.inria.fr/bin/caml-bugs FAQ: http://caml.inria.fr/FAQ/
Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
next prev parent reply other threads:[~2003-10-28 22:15 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2003-10-28 20:02 Dustin Sallings
2003-10-28 21:07 ` Richard Jones
2003-10-28 21:10 ` Maxence Guesdon [this message]
2003-10-29 0:11 ` Dustin Sallings
2003-10-29 6:50 ` Jean-Baptiste Rouquier
2003-10-29 7:52 ` Dustin Sallings
2003-10-29 10:00 ` David Brown
2003-10-29 18:31 ` skaller
2003-10-29 18:25 ` skaller
2003-10-29 21:09 ` Richard Jones
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=20031028221048.733a71fe.maxence.guesdon@inria.fr \
--to=maxence.guesdon@inria.fr \
--cc=caml-list@inria.fr \
--cc=dustin@spy.net \
--cc=rich@annexia.org \
/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).