From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: weis Received: (from weis@localhost) by pauillac.inria.fr (8.7.6/8.7.3) id TAA19171 for caml-redistribution; Mon, 31 Aug 1998 19:17:04 +0200 (MET DST) Received: from nez-perce.inria.fr (nez-perce.inria.fr [192.93.2.78]) by pauillac.inria.fr (8.7.6/8.7.3) with ESMTP id OAA29494 for ; Mon, 31 Aug 1998 14:45:14 +0200 (MET DST) Received: from info.numeric-quest.com (info.numeric-quest.com [204.187.76.36]) by nez-perce.inria.fr (8.8.7/8.8.7) with ESMTP id OAA15613 for ; Mon, 31 Aug 1998 14:45:10 +0200 (MET DST) Received: from localhost (jans@localhost) by info.numeric-quest.com (8.8.5/8.8.5) with SMTP id HAA20972; Mon, 31 Aug 1998 07:48:17 -0500 Date: Mon, 31 Aug 1998 07:48:16 -0500 (CDT) From: Jan Skibinski To: "Adam P. Jenkins" cc: jay@compiler.kaist.ac.kr, Vincent Poirriez , caml-list@inria.fr Subject: RE: documentation automatique In-Reply-To: <000001bdd38c$a56517f0$9d8c5ed1@dwarin> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: weis On Sat, 29 Aug 1998, Adam P. Jenkins wrote: > 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. And soon all sources would be obfuscated by all sorts of tags, and hardly directly readable by a programmer. Unless we have built powerful tools, where original source is no longer important -- as in Smalltalk or Eiffel -- this does not look to me as a good idea. See http://www.numeric-quest.com/news/NQ-comments.html Jan