You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by Kev Jackson <ke...@it.fts-vn.com> on 2004/12/08 06:21:54 UTC
[Patch] DirectoryScanner
- Added javadoc (@param etc)
- changed from <CODE> to <code> for XHTML compliance
- removed unnecessary nesting
if (condition) {
return foo;
} else { <-- not required - although I can see that in some ways it
helps readability
if (conition) {
return bar;
}
No unit tests with this
Kev
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org
Re: [Patch] DirectoryScanner
Posted by Kev Jackson <ke...@it.fts-vn.com>.
>> /**
>>- * gets whether or not a DirectoryScanner
>>follows symbolic links
>>+ * Sets whether or not a DirectoryScanner
>>follows symbolic links
>> *
>>- * @return flag indicating whether symbolic
>>links should be followed
>>+ * @return whether or not symbolic links should
>>be followed
>> *
>> * @since ant 1.6
>> */
>>
>>
>[SNIP]
>
>Is that the doc for isFollowSymlinks() that you have
>changed to "Sets whether..."?
>
>
Yes, sorry typo, but a very bad one at that since it is the complete
opposite of the code.
I wonder if there is a javadoc tool that will check the semantic meaning
of comments against code - similar to checkstyle but comparing method
code vs doc comments. That would catch these mistakes without hassling
overworked commiters :)
Sorry again, I'll try to be more careful with anything else that I
submit. /me suitably chastised.
Kev
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org
Re: [Patch] DirectoryScanner
Posted by Matt Benson <gu...@yahoo.com>.
--- Kev Jackson <ke...@it.fts-vn.com> wrote:
[SNIP]
> /**
> - * gets whether or not a DirectoryScanner
> follows symbolic links
> + * Sets whether or not a DirectoryScanner
> follows symbolic links
> *
> - * @return flag indicating whether symbolic
> links should be followed
> + * @return whether or not symbolic links should
> be followed
> *
> * @since ant 1.6
> */
[SNIP]
Is that the doc for isFollowSymlinks() that you have
changed to "Sets whether..."?
-Matt
__________________________________
Do you Yahoo!?
Read only the mail you want - Yahoo! Mail SpamGuard.
http://promotions.yahoo.com/new_mail
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org
Re: [Patch] DirectoryScanner
Posted by Kev Jackson <ke...@it.fts-vn.com>.
Sorry, helps if I attach the file eh?
> - Added javadoc (@param etc)
> - changed from <CODE> to <code> for XHTML compliance
> - removed unnecessary nesting
> if (condition) {
> return foo;
> } else { <-- not required - although I can see that in some ways it
> helps readability
> if (conition) {
> return bar;
> }
>
> No unit tests with this
> Kev
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
> For additional commands, e-mail: dev-help@ant.apache.org
>