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=none 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 25A84BBCA for ; Mon, 5 May 2008 10:11:06 +0200 (CEST) X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AsYBAENdHkjAXQIniGdsb2JhbACRdQEBAQ8gl1E X-IronPort-AV: E=Sophos;i="4.27,437,1204498800"; d="scan'208";a="11839008" Received: from concorde.inria.fr ([192.93.2.39]) by mail1-smtp-roc.national.inria.fr with ESMTP; 05 May 2008 10:11:05 +0200 Received: from mail3-relais-sop.national.inria.fr (mail3-relais-sop.national.inria.fr [192.134.164.104]) by concorde.inria.fr (8.13.6/8.13.6) with ESMTP id m458B5Yd005064 (version=TLSv1/SSLv3 cipher=RC4-SHA bits=128 verify=OK) for ; Mon, 5 May 2008 10:11:05 +0200 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AsQBAENdHkiBrw8EZGdsb2JhbACRaBoFCAcSl1A X-IronPort-AV: E=Sophos;i="4.27,437,1204498800"; d="scan'208";a="12252741" Received: from ext.lri.fr ([129.175.15.4]) by mail3-smtp-sop.national.inria.fr with ESMTP; 05 May 2008 10:11:05 +0200 Received: from localhost (localhost [127.0.0.1]) by ext.lri.fr (Postfix) with ESMTP id 24251A4796; Mon, 5 May 2008 10:11:05 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at lri.fr Received: from ext.lri.fr ([127.0.0.1]) by localhost (ext.lri.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id qprfg5qeh3ae; Mon, 5 May 2008 10:11:05 +0200 (CEST) Received: from smtp.lri.fr (vhost3-23 [129.175.3.23]) by ext.lri.fr (Postfix) with ESMTP id 0C4D6A4791; Mon, 5 May 2008 10:11:05 +0200 (CEST) Received: from serveur9-10.lri.fr (serveur9-10 [129.175.9.10]) by smtp.lri.fr (Postfix) with ESMTP id 0512CE053E; Mon, 5 May 2008 10:11:05 +0200 (CEST) Received: from localhost ([127.0.0.1] ident=signoles) by serveur9-10.lri.fr with esmtp (Exim 3.36 #1 (Debian)) id 1Jsvmq-0004HC-00; Mon, 05 May 2008 10:11:04 +0200 Date: Mon, 5 May 2008 10:11:04 +0200 (CEST) From: Julien Signoles To: David Teller Cc: OCaml Subject: Re: [Caml-list] Documenting submodules ? In-Reply-To: <1209593864.6823.36.camel@Blefuscu> Message-ID: References: <1209593864.6823.36.camel@Blefuscu> MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed X-Miltered: at concorde with ID 481EC119.000 by Joe's j-chkmail (http://j-chkmail . ensmp . fr)! X-Spam: no; 0.00; signoles:01 signoles:01 lri:01 submodules:01 ocamldoc:01 ocamldoc:01 submodule:01 submodule:01 struct:01 struct:01 -version:01 -html:01 caml-list:01 modules:02 module:03 > 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