English version
Accueil     À propos     Téléchargement     Ressources     Contactez-nous    

Ce site est rarement mis à jour. Pour les informations les plus récentes, rendez-vous sur le nouveau site OCaml à l'adresse ocaml.org.

Browse thread
documentation automatique
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: 1998-08-31 (11:56)
From: Adam P. Jenkins <ajenkins@j...>
Subject: RE: documentation automatique
> | It should be nice if an automatic documentation tool could be provided
> | for ocaml. It should take .ml and/or .mli files correctly documented
> | and return a nice latex/html (eventually via HeVeA) docummentation.
>   I don't know what you exactly want, but if you want to convert your
>   caml code to html with syntax coloring and the like, I'd suggest you

I think he means something like Javadoc, but for O'Caml instead of Java.
With Javadoc, you put a comment in front of every function or class in your
code, using some special format for the comments, and then run Javadoc with
the source code as input.  It extracts the special comments and generates an
HTML document for your code.  I've seen several programs like this for C++
also, but not for Caml yet.