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: Jean-Christophe Filliatre <Jean-Christophe.Filliatre@l...>
Subject: Re: [Caml-list] OCaml and doxygen???

On Thu, 2004-10-07 at 03:30, 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?

I've developed a literate programming tool for Ocaml, ocamlweb. See
http://www.lri.fr/~filliatr/ocamlweb/ 

You'll find many examples of ocamlweb output on this page:
http://www.lri.fr/~filliatr/software.en.html (looking at the .ps links)

Though ocamlweb  was inspired  by Knuth's WEB  it only  implements the
pretty-printing  and  indexing   features,  not  the  weaving  feature
(i.e. the ability to present pieces  of code in an arbitrary order). I
consider ocaml to be structured enough.  ocamlweb is assuming comments
to be written  in LaTeX (unless declared as  true comments that should
be ignored).

I wrote this  tool to get nice listings of  my code, following Knuth's
principle that a  program should be something as  beautiful as a book,
readable by a human (and not only a machine).

-- 
Jean-Christophe Filliātre

-------------------
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