From: "lehalle@miriad" <charles.lehalle@miriadtech.com>
To: caml-list@inria.fr
Subject: Re: [Caml-list] OCaml and doxygen???
Date: Thu, 07 Oct 2004 09:59:19 +0200 [thread overview]
Message-ID: <opsfhps5g41j4mhy@tahiti2.miriad.fr> (raw)
In-Reply-To: <20041006184618.GA6605@ceres.cs.mu.oz.au>
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
next prev parent reply other threads:[~2004-10-07 7:59 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-10-06 17:30 Vasili Galchin
2004-10-06 18:46 ` David Overton
2004-10-07 0:59 ` skaller
2004-10-07 7:59 ` lehalle@miriad [this message]
2004-10-07 0:57 ` skaller
2004-10-07 12:35 ` Jean-Christophe Filliatre
2004-10-07 18:41 ` Norman Ramsey
2004-10-08 11:07 ` David MENTRE
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=opsfhps5g41j4mhy@tahiti2.miriad.fr \
--to=charles.lehalle@miriadtech.com \
--cc=caml-list@inria.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