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 BAA29346; Wed, 29 Oct 2003 01:11:35 +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 BAA09756 for ; Wed, 29 Oct 2003 01:11:34 +0100 (MET) Received: from bob.west.spy.net (mail.west.spy.net [66.149.231.226]) by nez-perce.inria.fr (8.11.1/8.11.1) with ESMTP id h9T0BX116804; Wed, 29 Oct 2003 01:11:33 +0100 (MET) Received: from spy.net (sjc-dist3-e3.2wire.com [63.203.253.2]) by bob.west.spy.net (Postfix) with ESMTP id D92245972; Tue, 28 Oct 2003 16:11:26 -0800 (PST) Date: Tue, 28 Oct 2003 16:11:30 -0800 Subject: Re: [Caml-list] non-exported functions Content-Type: text/plain; charset=US-ASCII; format=flowed Mime-Version: 1.0 (Apple Message framework v552) Cc: Richard Jones , caml-list@inria.fr To: Maxence Guesdon From: Dustin Sallings In-Reply-To: <20031028221048.733a71fe.maxence.guesdon@inria.fr> Message-Id: <728D3F38-09A4-11D8-B9F5-000393CFE6B8@spy.net> Content-Transfer-Encoding: 7bit X-Mailer: Apple Mail (2.552) X-Loop: caml-list@inria.fr X-Spam: no; 0.00; caml-list:01 helper:01 ocamldoc:01 mli:01 mli:01 maxence:01 guesdon:01 ocamldoc:01 undocumented:01 0000:98 unbound:02 module:03 module:03 wrote: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. 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