From mboxrd@z Thu Jan  1 00:00:00 1970
X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me
X-Spam-Level: 
X-Spam-Status: No, score=-1.3 required=5.0 tests=BAYES_00,INVALID_MSGID
	autolearn=no autolearn_force=no version=3.4.4
X-Google-Language: ENGLISH,ASCII-7-bit
X-Google-Thread: 103376,3334f982144a667d
X-Google-Attributes: gid103376,public
From: Brian Rogoff <bpr@shell5.ba.best.com>
Subject: Re: javadoc => adadoc?
Date: 1998/08/04
Message-ID: <Pine.BSF.3.96.980804092449.11315B-100000@shell5.ba.best.com>#1/1
X-Deja-AN: 377866428
References: <6ptlbe$k3$1@nnrp1.dejanews.com> <6pvslq$poo@drn.newsguy.com>
 <6q4k5q$10uo$1@mdnews.btv.ibm.com> <35C5DAC4.F68DA421@earthling.net>
 <dewar.902212445@merv> <1998Aug4.073510.1@eisner>
 <6q7773$mhi$1@mdnews.btv.ibm.com>
Content-Type: TEXT/PLAIN; charset=US-ASCII
X-Trace: 902249072 15738 bpr  206.184.139.132
Mime-Version: 1.0
Newsgroups: comp.lang.ada
Date: 1998-08-04T00:00:00+00:00
List-Id: <comp.lang.ada>

On Tue, 4 Aug 1998, Norman H. Cohen wrote:
... snip ...
> To summarize, javadoc is a handy tool which can provide effective
> component-user documentation when used in a conscientiously applied program
> of thorough commentary.  It does not produce design documentation, and it
> does not produce decent user documentation without human effort.  Ada would
> benefit from a similar tool.  (Wasn't a grad student at GWU working on one a
> couple of years ago?)

My own experience with the Java tools confirms this. If anything I found
that the psychological effect was the opposite of what was described;
programmers spent more time carefully documenting the code and keeping the 
user level documentation up to date with the javadoc tool. 

There are a few other tools which would be nice in an Ada environment,
like an Ada version of LCLint from the Larch toolkit (*), or a more 
general version of the SPARK analysis tools.

-- Brian

(*) http://www.sds.lcs.mit.edu/spd/larch/index.html