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 mail2-relais-roc.national.inria.fr (mail2-relais-roc.national.inria.fr [192.134.164.83]) by yquem.inria.fr (Postfix) with ESMTP id 67D7ABBC1 for ; Thu, 1 May 2008 21:52:06 +0200 (CEST) X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AhsCAMW8GUjAXQIniGdsb2JhbACRXgEBAQ8glSGFPw X-IronPort-AV: E=Sophos;i="4.27,423,1204498800"; d="scan'208";a="10300818" Received: from concorde.inria.fr ([192.93.2.39]) by mail2-smtp-roc.national.inria.fr with ESMTP; 01 May 2008 21:52:05 +0200 Received: from mail1-relais-roc.national.inria.fr (mail1-relais-roc.national.inria.fr [192.134.164.82]) by concorde.inria.fr (8.13.6/8.13.6) with ESMTP id m41Jq5wF024309 (version=TLSv1/SSLv3 cipher=RC4-SHA bits=128 verify=OK) for ; Thu, 1 May 2008 21:52:05 +0200 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AvABAMW8GUhIDtyac2dsb2JhbACRXgEMAwQECQ8FlR6FPw X-IronPort-AV: E=Sophos;i="4.27,423,1204498800"; d="scan'208";a="11735549" Received: from fg-out-1718.google.com ([72.14.220.154]) by mail1-smtp-roc.national.inria.fr with ESMTP; 01 May 2008 21:52:05 +0200 Received: by fg-out-1718.google.com with SMTP id 13so675370fge.25 for ; Thu, 01 May 2008 12:52:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:received:message-id:date:from:user-agent:mime-version:to:cc:subject:references:in-reply-to:content-type:content-transfer-encoding:sender; bh=hn9/gqbpApgNvo+Xp3NOZPUi9MEl2R4UvTHQ6j8FoD4=; b=cAp5NFy/Bjw/07kYGD72xaoIsnig1p5ZghzRMd5Ao2nX9BwY+th//IuP+Xo2JuMxr+/SqayGAA61RM+TIYrgvBsT8uzG83OXzKeApgNOFS8gXZMuCzt8pRKfvlnKc/RT9OKKMEzyzPViGqtXklo3z6oRzF16imhXEL5I30lEuV0= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=message-id:date:from:user-agent:mime-version:to:cc:subject:references:in-reply-to:content-type:content-transfer-encoding:sender; b=oQbTxLJxI4FJ8qyHcb01VPVG7UlMJaO+OYQMypD4OGIi0nPg2XUw8YNmZUHSjbhoQ8Tn7zS1wDLSFjJN/Gyzn4Q90DWnxfgkuAZun9vbgYRNqQRmAZizlluhS6SnTLV0/5tlUgOtF8OOfKOmEmUNPWGfHN3gUTv2fPYUAyYPnTA= Received: by 10.86.98.18 with SMTP id v18mr1953633fgb.59.1209671524925; Thu, 01 May 2008 12:52:04 -0700 (PDT) Received: from ?192.168.0.123? ( [83.248.233.191]) by mx.google.com with ESMTPS id w5sm10991697mue.11.2008.05.01.12.52.02 (version=SSLv3 cipher=RC4-MD5); Thu, 01 May 2008 12:52:03 -0700 (PDT) Message-ID: <481A1F5F.2040004@lix.polytechnique.fr> Date: Thu, 01 May 2008 21:51:59 +0200 From: Arnaud Spiwack User-Agent: Thunderbird 2.0.0.12 (Windows/20080213) MIME-Version: 1.0 To: David Teller Cc: OCaml Subject: Re: [Caml-list] Documenting submodules ? References: <1209593864.6823.36.camel@Blefuscu> In-Reply-To: <1209593864.6823.36.camel@Blefuscu> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 8bit Sender: Arnaud Spiwack X-Miltered: at concorde with ID 481A1F65.000 by Joe's j-chkmail (http://j-chkmail . ensmp . fr)! X-Spam: no; 0.00; lix:01 submodules:01 ocamldoc:01 submodules:01 submodule:01 ocamldoc:01 mli:01 cheers:01 plug-in:98 plug-in:98 arnaud:01 arnaud:01 rewrite:01 caml-list:01 modules:02 As far as I'm aware, the HTML output of ocamldoc documents submodules as hyperlinks. By clicking on them you then get to a documentation of the submodule itself. This is already something. Arnaud Spiwack David Teller a écrit : > Dear list, > > As mentioned previously, I'm working on a derivative of ExtLib > (promised, I'll submit the changes within a few days). I've put together > most of the features I want for now, but I'm faced with a problem of > documentation. Essentially, I have a few big modules containing each a > few smaller modules -- each smaller module being defined in one file. > > 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. > > Is there any ocamldoc plug-in or ocamlbuild plug-in or anything else > that could help me document my code without having to rewrite everything > and/or to copy and paste thousands of lines of .mli ? > > Cheers, > David > >