From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.1.3 (2006-06-01) on yquem.inria.fr X-Spam-Level: X-Spam-Status: No, score=0.0 required=5.0 tests=AWL autolearn=disabled version=3.1.3 X-Original-To: caml-list@yquem.inria.fr Delivered-To: caml-list@yquem.inria.fr Received: from mail1-relais-roc.national.inria.fr (mail1-relais-roc.national.inria.fr [192.134.164.82]) by yquem.inria.fr (Postfix) with ESMTP id 68BFEBBCA for ; Mon, 5 May 2008 11:10:35 +0200 (CEST) X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AlYBAE5rHkjCpx6wlmdsb2JhbACRdQEBAQEJBQgYl2k X-IronPort-AV: E=Sophos;i="4.27,437,1204498800"; d="scan'208";a="11842884" Received: from smtpmin.univ-orleans.fr (HELO min.univ-orleans.fr) ([194.167.30.176]) by mail1-smtp-roc.national.inria.fr with ESMTP; 05 May 2008 11:10:34 +0200 Received: from smtps.univ-orleans.fr (localhost [127.0.0.1]) by min.univ-orleans.fr (Postfix) with ESMTP id 2F5D512B3F9; Mon, 5 May 2008 11:10:34 +0200 (CEST) Received: from [192.168.0.12] (ras75-4-82-235-58-110.fbx.proxad.net [82.235.58.110]) by smtps.univ-orleans.fr (Postfix) with ESMTP id 35EAA36E5B; Mon, 5 May 2008 11:10:35 +0200 (CEST) Subject: Re: [Caml-list] Documenting submodules ? From: David Teller To: Maxence Guesdon Cc: caml-list@yquem.inria.fr In-Reply-To: <20080505103513.6f48d8fc@alcazar.inria.fr> References: <1209593864.6823.36.camel@Blefuscu> <1209975770.6431.5.camel@Blefuscu> <20080505103513.6f48d8fc@alcazar.inria.fr> Content-Type: text/plain Date: Mon, 05 May 2008 11:12:05 +0200 Message-Id: <1209978725.6431.18.camel@Blefuscu> Mime-Version: 1.0 X-Mailer: Evolution 2.12.1 Content-Transfer-Encoding: 7bit X-Spam: no; 0.00; submodules:01 univ-orleans:01 0200,:01 maxence:01 guesdon:01 ocamldoc:01 ocamldoc:01 work-around:01 redefining:01 cheers:01 univ-orleans:01 lifo:01 plug-in:98 liquidations:98 wrote:01 On Mon, 2008-05-05 at 10:35 +0200, Maxence Guesdon wrote: > Indeed, ocamldoc does not use the comment of sub.ml in the page generated > for main.ml. This is normal behaviour. I'm aware that it's the normal behaviour of ocamldoc. I'm just looking for a work-around or a plug-in. > You could comment the creation of the > Sub module (i.e. Main.Sub) by putting a comment around > module Sub = Sub I wrote that in my first post :) More seriously, it's ok if I have only one or two modules. But if I want to comment both the creation of Sub and the actual contents of Sub, it's not really a good method. Even more so since I have 70+ modules developed separately, which I attempt to present with a consistent Java-style package hierarchy. That would mean copying and pasting about 9000+ lines of code for the moment, with more coming, and nasty bugs lurking whenever the source packages are updated. > This is normal behaviour too. You're redefining a module here, and the > way it is defined is reflected by the html code generated by ocamldoc, with > a link on the Sub.SubSub page. I have a link to an empty Sub.SubSub page. Is that normal behaviour ? Cheers, David -- David Teller Security of Distributed Systems http://www.univ-orleans.fr/lifo/Members/David.Teller Angry researcher: French Universities need reforms, but the LRU act brings liquidations.