caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: "Adam P. Jenkins" <ajenkins@javanet.com>
To: <jay@compiler.kaist.ac.kr>,
	"Vincent Poirriez" <poirriez@univ-valenciennes.fr>
Cc: <caml-list@inria.fr>
Subject: RE: documentation automatique
Date: Sat, 29 Aug 1998 16:36:05 -0400	[thread overview]
Message-ID: <000001bdd38c$a56517f0$9d8c5ed1@dwarin> (raw)
In-Reply-To: <yf4zpcp3j6c.fsf@ruby.kaist.ac.kr>

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

Adam






  reply	other threads:[~1998-08-31 11:56 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
1998-08-27 12:39 Vincent Poirriez
1998-08-28  2:59 ` Jae-Youn Chung
1998-08-29 20:36   ` Adam P. Jenkins [this message]
1998-08-31 12:48     ` Jan Skibinski
1998-08-31  6:47 ` Francois Pessaux
1998-08-31 12:48 Sven
1998-09-01  9:11 ` Fabrice Le Fessant
1998-08-31 14:36 Ken Wakita

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='000001bdd38c$a56517f0$9d8c5ed1@dwarin' \
    --to=ajenkins@javanet.com \
    --cc=caml-list@inria.fr \
    --cc=jay@compiler.kaist.ac.kr \
    --cc=poirriez@univ-valenciennes.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).