Version française
Home     About     Download     Resources     Contact us    
Browse thread
[Caml-list] OCaml and doxygen???
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: lehalle@miriad <charles.lehalle@m...>
Subject: Re: [Caml-list] OCaml and doxygen???
On Wed, 6 Oct 2004 19:46:18 +0100, David Overton <dmo@cs.mu.OZ.AU> 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