Version française
Home     About     Download     Resources     Contact us    

This site is updated infrequently. For up-to-date information, please visit the new OCaml website at

Browse thread
[Caml-list] [ANNOUNCE] ocamlconf-0.5 release
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: 2004-05-12 (21:53)
From: Kenneth Knowles <kknowles@b...>
Subject: Re: [Caml-list] [ANNOUNCE] ocamlconf-0.5 release
On Wed, May 12, 2004 at 02:20:20PM -0600, William D. Neumann wrote:
> This is really, I suppose, the heart of my complaint.  It seems that a
> number of OCaml developers are relying on ocamldoc as their primary
> documentation method.  While this may work more-or-less well for a library
> like mlgmp or similar, it is woefully inadequate for documenting anything
> more substantial (e.g. applications).

I basically think of OCamlConf as a library, but agree that ocamldoc output is
not appropriate for applications.  Every time I sit down to write a user's
manual for ocamlconf (It is on the gameplan!) I end up re-hashing the inline
comments almost word-for-word.  I'm not sure the best way to write a tutorial
that is heavily hyperlinked into the code, so it just gives a friendly front-end
to the API.  I'll take a look at ocamlweb; I'm curious about literate programming
but usually find that the ordering necessary in prose is inconvenient for code.


To unsubscribe, mail Archives:
Bug reports: FAQ:
Beginner's list: