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
[Caml-list] CDK binary release
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: 2001-05-11 (11:58)
From: Fabrice Le Fessant <fabrice.le_fessant@i...>
Subject: Re: [Caml-list] CDK binary release

>  On Thu, 10 May 2001, Fabrice Le Fessant wrote:
>  > The CDK documentation tool has still many problems, but it is
>  > currently the only tool which produces man pages for Ocaml modules and
>  > functions.
>  Out of curiosity, who wants to be reading Ocaml documentation through man
>  pages?  I would think HTML and texinfo would both be nicer formats to work
>  with. Is there some advantage that I'm missing?

You mean that, because you don't like man pages, nobody like them ?

HTML is already supported, I have nothing against texinfo. But, do you
know a tool to generate it from all the mli files from the CDK (that
use different formatting conventions) ? Can you send me a patch to the
CDK to use it ? Are you sure it is installed on all computers that
will compile the CDK documentation ?

For LaTeX, we will not force people to use LaTeX to document their
interfaces: most comments are simple text lines including some pieces
of code (in cdk_doc, they simply have to be between brackets). Only
section titles have to be handled differently. cdk_doc is enough for
that. New output formats have to be added, and all interfaces have to
be completely translated to the input format ... We are not writting a
book, but only a reference manual, thus, we don't need SGML or
complicated formatting tool for that !

- Fabrice
To unsubscribe, mail caml-list-request@inria.fr.  Archives: http://caml.inria.fr