From: Charles Hixson <charleshixson@earthling.net>
Subject: Re: javadoc => adadoc?
Date: 1998/08/04
Date: 1998-08-04T00:00:00+00:00 [thread overview]
Message-ID: <35C7401E.54F17899@earthling.net> (raw)
In-Reply-To: Pine.BSF.3.96.980804092449.11315B-100000@shell5.ba.best.com
Brian Rogoff wrote:
>
... snip ...
> ... 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
Yes, the javaDoc structure seems to encourage keeping the documentation
(annotations) up to date. The problem is that the extracted files are
HTML, and there doesn't seem to be any decent way of presenting them
off-line (and also, searching through html almost REQUIRES a search
engine). What is needed is some way of marking index entries, and a way
to generate (rtf?) text with the index entries tied to page numbers
(which must be determined at print time).
--
Charles Hixson charleshixson@earthling.net
(510) 464-7733 or chixso@mtc.dst.ca.us
next prev parent reply other threads:[~1998-08-04 0:00 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
1998-07-31 0:00 javadoc => adadoc? nelson
1998-08-01 0:00 ` nabbasi
1998-08-03 0:00 ` Norman H. Cohen
1998-08-03 0:00 ` Charles Hixson
1998-08-04 0:00 ` Robert Dewar
1998-08-04 0:00 ` Larry Kilgallen
1998-08-04 0:00 ` Norman H. Cohen
1998-08-04 0:00 ` Brian Rogoff
1998-08-04 0:00 ` Charles Hixson [this message]
1998-08-17 0:00 ` Peter Hermann
1998-08-17 0:00 ` Corey Minyard
1998-08-18 0:00 ` Charles Hixson
1998-08-19 0:00 ` Samuel Tardieu
1998-08-26 0:00 ` Simon Wright
1998-08-01 0:00 ` Matthew Heaney
replies disabled
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox