harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Anton Luht (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HARMONY-584) missing descriptions in @param tags
Date Fri, 21 Jul 2006 16:00:14 GMT
    [ http://issues.apache.org/jira/browse/HARMONY-584?page=comments#action_12422689 ] 
Anton Luht commented on HARMONY-584:

Alexey, sorry for late responce,

I've tested javadoc from 1.4 5 jre and both don't fail. But this style of comments certainly
contradicts with writing doc comments guidelines


Avoid - The description below says nothing beyond what you know from reading the method name

Please note that I've marked this issue as an improvement not a bug.

> missing descriptions in @param tags
> -----------------------------------
>                 Key: HARMONY-584
>                 URL: http://issues.apache.org/jira/browse/HARMONY-584
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>            Reporter: Anton Luht
>            Priority: Trivial
>         Attachments: check_incorrect_param.sh, incorrect_param.zip
> Some of .java sources have empty descriptions in @param tags, for example
> @param <param name>
> though they should have descriptions, e.g.
> @param <param name> <description>
> Please see the script for detecting such problems  and results of checking SVN 412715

This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


View raw message