From mboxrd@z Thu Jan 1 00:00:00 1970 Received: (from majordomo@localhost) by pauillac.inria.fr (8.7.6/8.7.3) id XAA07245; Tue, 28 Oct 2003 23:15:56 +0100 (MET) X-Authentication-Warning: pauillac.inria.fr: majordomo set sender to owner-caml-list@pauillac.inria.fr using -f Received: from nez-perce.inria.fr (nez-perce.inria.fr [192.93.2.78]) by pauillac.inria.fr (8.7.6/8.7.3) with ESMTP id XAA04553 for ; Tue, 28 Oct 2003 23:15:55 +0100 (MET) Received: from kraid.nerim.net (smtp-102-tuesday.nerim.net [62.4.16.102]) by nez-perce.inria.fr (8.11.1/8.11.1) with ESMTP id h9SMFs111844 for ; Tue, 28 Oct 2003 23:15:55 +0100 (MET) Received: from haddock.max.fr (zoggy.net1.nerim.net [62.212.116.8]) by kraid.nerim.net (Postfix) with SMTP id E1A0140E40; Tue, 28 Oct 2003 23:15:52 +0100 (CET) Date: Tue, 28 Oct 2003 22:10:48 +0100 From: Maxence Guesdon To: Richard Jones Cc: Dustin Sallings , caml-list@inria.fr Subject: Re: [Caml-list] non-exported functions Message-Id: <20031028221048.733a71fe.maxence.guesdon@inria.fr> In-Reply-To: <20031028210756.GA27347@redhat.com> References: <20031028210756.GA27347@redhat.com> Organization: INRIA X-Mailer: Sylpheed version 0.9.6claws (GTK+ 1.2.10; i686-pc-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Loop: caml-list@inria.fr X-Spam: no; 0.00; maxence:01 guesdon:01 maxence:01 guesdon:01 caml-list:01 helper:01 ocamldoc:01 mli:01 mli:01 ocamldoc:01 flags:01 0000:98 module:03 module:03 wrote:03 Sender: owner-caml-list@pauillac.inria.fr Precedence: bulk On Tue, 28 Oct 2003 21:07:57 +0000 Richard Jones 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