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 Tue, 19 Feb 2002 18:30:33 GMT
> Saw a couple of minor issues with this patch.
> 1. In many places is this: (String->Class).
>    It would be better as: (String-&gt;Class).

I pondered this myself. Obviously from a purist point of view, you're right - but then the
source code ends up being harder to read. (These comments tend to be for fields which are
private, and thus most likely to be seen in the context of viewing the source code, which
makes it more of a problem.) I tried to think up some alternatives, but couldn't come up with
anything as good. Possibly just (String-Class) or (String to Class)?
 
> 2. In at least a couple of places you've added // comments after the
> javadoc comment but before a method, i.e. IntrospectionHelper and
> createAttributeSetter.  Unless something's changed in a 
> recent version of
> javadoc, the // comments will prevent javadoc from 
> associating the javadoc
> comment with the method, etc. below it.  Have you checked to make sure
> javadoc is being generated for these methods?

It's certainly working with the 1.4 JavaDoc. (I'm using that to get rid of breakiterator warnings
as I go.) I'm pretty sure it was working when I used 1.3.1 as well, although I can't be sure.
If it breaks things for 1.1 and/or 1.2 though, I'm happy to go back and fix this up. Any caveats
about putting those comments just *before* the JavaDoc comments?

> Otherwise, nice job.  

Cheers :)

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