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 mail4-relais-sop.national.inria.fr (mail4-relais-sop.national.inria.fr [192.134.164.105]) by yquem.inria.fr (Postfix) with ESMTP id 2F73BBBCA for ; Mon, 5 May 2008 10:21:45 +0200 (CEST) X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AsYBAIhgHkjAXQImiGdsb2JhbACRdQEBAQ8glz8 X-IronPort-AV: E=Sophos;i="4.27,437,1204498800"; d="scan'208";a="25829246" Received: from discorde.inria.fr ([192.93.2.38]) by mail4-smtp-sop.national.inria.fr with ESMTP; 05 May 2008 10:21:44 +0200 Received: from mail3-relais-sop.national.inria.fr (mail3-relais-sop.national.inria.fr [192.134.164.104]) by discorde.inria.fr (8.13.6/8.13.6) with ESMTP id m458LhuC030993 (version=TLSv1/SSLv3 cipher=RC4-SHA bits=128 verify=OK) for ; Mon, 5 May 2008 10:21:44 +0200 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AlYBAP5gHkjCpx6wlmdsb2JhbACRdQEBAQEJBQgYl0Q X-IronPort-AV: E=Sophos;i="4.27,437,1204498800"; d="scan'208";a="12253297" Received: from smtpmin.univ-orleans.fr (HELO min.univ-orleans.fr) ([194.167.30.176]) by mail3-smtp-sop.national.inria.fr with ESMTP; 05 May 2008 10:21:19 +0200 Received: from smtps.univ-orleans.fr (localhost [127.0.0.1]) by min.univ-orleans.fr (Postfix) with ESMTP id 6D5E612B405; Mon, 5 May 2008 10:21:19 +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 1F20D36E5B; Mon, 5 May 2008 10:21:20 +0200 (CEST) Subject: Re: [Caml-list] Documenting submodules ? From: David Teller To: Julien Signoles Cc: OCaml In-Reply-To: References: <1209593864.6823.36.camel@Blefuscu> Content-Type: text/plain Date: Mon, 05 May 2008 10:22:50 +0200 Message-Id: <1209975770.6431.5.camel@Blefuscu> Mime-Version: 1.0 X-Mailer: Evolution 2.12.1 Content-Transfer-Encoding: 7bit X-Miltered: at discorde with ID 481EC397.000 by Joe's j-chkmail (http://j-chkmail . ensmp . fr)! X-Spam: no; 0.00; submodules:01 univ-orleans:01 rephrase:01 ocamldoc:01 struct:01 ocamlc:01 cheers:01 0200,:01 signoles:01 ocamldoc:01 submodule:01 submodule:01 struct:01 -version:01 -html:01 Let me rephrase: Case 1) ==== sub.ml (** This is [Sub] *) type t (** This is [Sub.t]*) ==== main.ml module Sub = Sub Running ocamldoc drops the comments of sub.ml . Case 2) ==== sub.ml module SubSub = struct type t (** This is [SubSub.t] *) end ==== main.ml module SubSubSub = Sub.SubSub Running ocamlc drops the comments of sub.ml -- and the very existence of SubSub.t. Cheers, David On Mon, 2008-05-05 at 10:11 +0200, Julien Signoles wrote: > > When invoking ocamldoc, either directly or through ocamlbuild + .odocl, > > the generated documentation only contains the name of modules, without > > any of the comments or even the values. > > Usually ocamldoc works fine with submodule: > > ===== sub.ml > (** This is {!A}. It contains a properly-documented submodule {!A.B} and a > single value {!A.a}. *) > module A = struct > > (** This is {!B}. It contains a single value {!B.b}. *) > module B = struct let b = 1 end > > let a = 0 > > end > ===== > > $ ocamldoc -version > Ocamldoc 3.10.1 > $ ocamldoc -html sub.ml > > Hope this helps, > Julien Signoles > -- 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.