caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Dustin Sallings <dustin@spy.net>
To: Maxence Guesdon <maxence.guesdon@inria.fr>
Cc: Richard Jones <rich@annexia.org>, caml-list@inria.fr
Subject: Re: [Caml-list] non-exported functions
Date: Tue, 28 Oct 2003 16:11:30 -0800	[thread overview]
Message-ID: <728D3F38-09A4-11D8-B9F5-000393CFE6B8@spy.net> (raw)
In-Reply-To: <20031028221048.733a71fe.maxence.guesdon@inria.fr>


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.

	I kinda liked automatically generating my .mli, but I guess I can live 
with that.


On Tuesday, Oct 28, 2003, at 13:10 US/Pacific, Maxence Guesdon wrote:

> 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.

	I rearranged my definitions to allow me to do this, but it prevents me 
from actually using them myself.  I get an ``Unbound value'' error.  
Does this mean I can't have both a section of undocumented code and use 
that code from the documented code?

-- 
Dustin Sallings

-------------------
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


  reply	other threads:[~2003-10-29  0:11 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
2003-10-29  0:11     ` Dustin Sallings [this message]
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=728D3F38-09A4-11D8-B9F5-000393CFE6B8@spy.net \
    --to=dustin@spy.net \
    --cc=caml-list@inria.fr \
    --cc=maxence.guesdon@inria.fr \
    --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).