ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jon Skeet" <jon.sk...@peramon.com>
Subject RE: [PATCH] /src/main/org/apache/tools/ant/IntrospectionHelper.java (More JavaDocs)
Date Wed, 20 Feb 2002 10:38:34 GMT
> On Wed, 20 Feb 2002, Jon Skeet <jon.skeet@peramon.com> wrote:
> 
> > JavaDoc will barf with an error if it can't find referenced classes
> > etc.
> 
> I have no problem here, all I have to do is to set maxmemory, as
> javadoc will run out of memory otherwise, but with an empty CLASSPATH
> (i.e. no single optional library installed) I still get javadocs.  I
> get messages about too many errors and tons of warnings, but the docs
> will be created.

Yup, you're right. 

Oddly enough, I don't need maxmemory, and if I try to specify it I get an error under 1.1.8:
[javadoc] javadoc: invalid flag: -J-mx131072000

If I get time I'll investigate that further and fix it or submit a bug about it (if there
isn't one already).

I'd forgotten how much difference the frames under 1.2+ make :)

Having bounced this back and forth (both in my head and on the list), I reckon it makes sense
to do the following:

o Use @link where appropriate, but not gratuitously. It can benefit lots of people, at the
cost of a warning for those using 1.1 (who will get lots of warnings etc anyway, unless they're
insanely careful)

o Change @throws to @exception everywhere. They're synonyms, so we might as well go for the
backwardly compatible version even if it isn't as "natural" when reading the source (IMO)

Any objections before I start doing this? (Sorry if I seem to be getting caught up on the
details here - it just  makes sense to get things right to start with, so I don't have to
redo too many things later.)

Jon

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message