Version française
Home     About     Download     Resources     Contact us    
Browse thread
[Caml-list] non-exported functions
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: Dustin Sallings <dustin@s...>
Subject: Re: [Caml-list] non-exported functions

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