Browse thread
[Caml-list] non-exported functions
[
Home
]
[ Index:
by date
|
by threads
]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
| Date: | -- (:) |
| From: | Maxence Guesdon <maxence.guesdon@i...> |
| 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. 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