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 JAA19522; Thu, 7 Oct 2004 09:59:21 +0200 (MET DST) X-Authentication-Warning: pauillac.inria.fr: majordomo set sender to owner-caml-list@pauillac.inria.fr using -f Received: from concorde.inria.fr (concorde.inria.fr [192.93.2.39]) by pauillac.inria.fr (8.7.6/8.7.3) with ESMTP id JAA20223 for ; Thu, 7 Oct 2004 09:59:20 +0200 (MET DST) Received: from smtp-ft6.fr.colt.net (smtp-ft6.fr.colt.net [213.41.78.209]) by concorde.inria.fr (8.13.0/8.13.0) with ESMTP id i977xJIu031707 for ; Thu, 7 Oct 2004 09:59:20 +0200 Received: from tahiti2.miriad.fr (host.194.193.23.62.rev.coltfrance.com [62.23.193.194]) by smtp-ft6.fr.colt.net with ESMTP id i977xJM17760 for ; Thu, 7 Oct 2004 09:59:19 +0200 Date: Thu, 07 Oct 2004 09:59:19 +0200 To: caml-list@inria.fr Subject: Re: [Caml-list] OCaml and doxygen??? Reply-To: charles.lehalle@miriadtech.com References: <20041006173007.14593.qmail@web53009.mail.yahoo.com> <20041006184618.GA6605@ceres.cs.mu.oz.au> From: "lehalle@miriad" Organization: MIRIAD Technologies Content-Type: text/plain; format=flowed; delsp=yes; charset=iso-8859-15 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Message-ID: In-Reply-To: <20041006184618.GA6605@ceres.cs.mu.oz.au> User-Agent: Opera M2/7.51 (Win32, build 3798) X-Miltered: at concorde with ID 4164F757.000 by Joe's j-chkmail (http://j-chkmail.ensmp.fr)! X-Loop: caml-list@inria.fr X-Spam: no; 0.00; caml-list:01 doxygen:01 lehalle:01 lehalle:01 miriadtech:01 2004:99 dmo:99 2004:99 doxygen:01 ocamldoc:01 quirks:01 renaming:01 ocamaweb:01 matlab:01 javadoc:01 Sender: owner-caml-list@pauillac.inria.fr Precedence: bulk On Wed, 6 Oct 2004 19:46:18 +0100, David Overton wrote: > On Wed, Oct 06, 2004 at 10:30:07AM -0700, Vasili Galchin wrote: >> To my knowledge http://www.doxygen.org only works with C/C++. Is >> there any general-purpose tool that allows one to do something >> like literate programming with OCaml? > > We've been using ocamldoc, which comes with the OCaml distribution, > quite successfully for producing documentation. It has a few quirks, > such as renaming type parameters in signatures to 'a, 'b, 'c, ... (not > helpful when you're trying to use more descriptive names), but is quite > powerful. I believe it's fairly similar to doxygen, but have not used > the latter. > > David ocamaweb is a good solution too, but has at this stage not extension (xml configuration file) for all languages. it works with MATLAB, awk, visual basic, SAS, etc (in fact, with languages having only line comments). it is according to me a good balance between javadoc/doxygen tools (too close to code structure) and web systems (that need a compilation/tangle to produce code). ocamaweb is widely used at miriad technologies for matlab documentations. http://sourceforge.net/projects/ocamaweb http://www.literateprogramming.com/ftools.html charles -- Charles-Albert Lehalle --- MIRIAD Technologies advanced projects manager mailto:charles.lehalle@miriadtech.com keyserver: http://pgp.mit.edu/ tel : 0156431816 - fax: 0156431828 8 av Hoche - 75008 PARIS - FRANCE ------------------- 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