caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: David Mentre <David.Mentre@inria.fr>
To: Markus Mottl <mottl@miss.wu-wien.ac.at>
Cc: Fabrice Le Fessant <fabrice.le_fessant@inria.fr>, caml-list@inria.fr
Subject: [Caml-list] About documentation tools
Date: 09 May 2001 14:01:23 +0200	[thread overview]
Message-ID: <qtlpudig298.fsf_-_@pochi.inria.fr> (raw)
In-Reply-To: <20010509125858.B28402@miss.wu-wien.ac.at>

Markus Mottl <mottl@miss.wu-wien.ac.at> writes:

>  Why not use e.g. Jean-Christophe Filliatre's ocamlweb?

ocamlweb intents to be a tool to document source code as Knuth's WEB
tool. In other words, it's more for internal code documentation than for
user manual and reference guide.

> How about the tool that INRIA uses? - Unfortunately, nobody has answered
> may recent question on this here yet... :(

As far as I know (despite my @inria.fr email, I'm not part of the Caml
team), the tool used by the Caml team is specific and not ready for a
public release, i.e. some shortcomings are solved in ad-hoc manner. 

But I agree that a recommended documentation tool would be a plus. It
does not mean that such a tool should be very elaborated. The simpler,
the better. And I also think that such a tool should be close to
standard tool in other languages, mostly javadoc. It would help the
transition from other languages (and multi-language developments).

My 2 cents,
Best regards,
david
-- 
 David.Mentre@inria.fr -- http://www.irisa.fr/prive/dmentre/
 Opinions expressed here are only mine.
-------------------
To unsubscribe, mail caml-list-request@inria.fr.  Archives: http://caml.inria.fr


  reply	other threads:[~2001-05-13 20:10 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2001-05-07  9:06 [Caml-list] CDK binary release Fabrice Le Fessant
2001-05-07 16:09 ` Miles Egan
2001-05-07 17:17 ` John Max Skaller
2001-05-09 10:58 ` Markus Mottl
2001-05-09 12:01   ` David Mentre [this message]
2001-05-09 13:18     ` [Caml-list] Re: About documentation tools Markus Mottl
2001-05-09 18:17       ` John Max Skaller
2001-05-09 17:58   ` [Caml-list] CDK binary release John Max Skaller
2001-05-09 22:40     ` Markus Mottl
2001-05-09 23:19       ` John Max Skaller
2001-05-10  9:19         ` Fabrice Le Fessant
2001-05-10 10:34           ` [Caml-list] CDK Documentation format Dave Mason
2001-05-13 21:26             ` Stefan Monnier
2001-05-10 11:16           ` [Caml-list] CDK binary release Sven LUTHER
2001-05-10 13:18             ` Markus Mottl
2001-05-10 15:42               ` Jean-Christophe Filliatre
2001-05-10 16:08                 ` Thorsten Ohl
2001-05-10 22:53                   ` Markus Mottl
2001-05-10 20:36                 ` John Max Skaller
2001-05-10 14:01             ` David Mentre
2001-05-10 15:09             ` Patrick M Doane
2001-05-10 15:06           ` Patrick M Doane
2001-05-11 11:58             ` Fabrice Le Fessant
2001-05-11 15:31               ` John Max Skaller
2001-05-11 15:44                 ` Fabrice Le Fessant
2001-05-13 21:33                 ` Stefan Monnier
2001-05-11 17:30               ` Patrick M Doane
2001-05-12  7:46                 ` Fabrice Le Fessant
2001-05-11 23:24               ` Brian Rogoff
2001-05-10 15:49           ` John Max Skaller
2001-05-14  8:21 ` Olivier Andrieu

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=qtlpudig298.fsf_-_@pochi.inria.fr \
    --to=david.mentre@inria.fr \
    --cc=caml-list@inria.fr \
    --cc=fabrice.le_fessant@inria.fr \
    --cc=mottl@miss.wu-wien.ac.at \
    /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).