You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by "Anton Luht (JIRA)" <ji...@apache.org> on 2006/06/08 15:53:29 UTC
[jira] Created: (HARMONY-584) missing descriptions in @param tags
missing descriptions in @param tags
-----------------------------------
Key: HARMONY-584
URL: http://issues.apache.org/jira/browse/HARMONY-584
Project: Harmony
Type: Improvement
Components: Classlib
Reporter: Anton Luht
Priority: Trivial
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 attached
--
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
[jira] Updated: (HARMONY-584) missing descriptions in @param tags
Posted by "Anton Luht (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-584?page=all ]
Anton Luht updated HARMONY-584:
-------------------------------
Attachment: incorrect_param.zip
check results for SVN contents ver. 412715
> missing descriptions in @param tags
> -----------------------------------
>
> Key: HARMONY-584
> URL: http://issues.apache.org/jira/browse/HARMONY-584
> Project: Harmony
> 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 attached
--
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
Re: [jira] Updated: (HARMONY-584) missing descriptions in @param tags
Posted by Mark Hindess <ma...@googlemail.com>.
On 4 August 2006 at 6:49, "Tim Ellison (JIRA)" <ji...@apache.org> wrote:
> [ http://issues.apache.org/jira/browse/HARMONY-584?page=all ]
>
> Tim Ellison updated HARMONY-584:
> --------------------------------
>
> Component/s: Contributions
> (was: Classlib)
>
> > missing descriptions in @param tags
> > -----------------------------------
> >
> > Key: HARMONY-584
> > URL: http://issues.apache.org/jira/browse/HARMONY-584
> > Project: Harmony
> > Issue Type: Improvement
> > Components: Contributions
> > 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 attached
I wonder if doctorj[1] checks for this. It certainly does pick up some
other useful issues.
-Mark.
[1] doctorj.sf.net
---------------------------------------------------------------------
Terms of use : http://incubator.apache.org/harmony/mailing.html
To unsubscribe, e-mail: harmony-dev-unsubscribe@incubator.apache.org
For additional commands, e-mail: harmony-dev-help@incubator.apache.org
[jira] Updated: (HARMONY-584) missing descriptions in @param tags
Posted by "Tim Ellison (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-584?page=all ]
Tim Ellison updated HARMONY-584:
--------------------------------
Component/s: Contributions
(was: Classlib)
> missing descriptions in @param tags
> -----------------------------------
>
> Key: HARMONY-584
> URL: http://issues.apache.org/jira/browse/HARMONY-584
> Project: Harmony
> Issue Type: Improvement
> Components: Contributions
> 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 attached
--
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
[jira] Commented: (HARMONY-584) missing descriptions in @param tags
Posted by "Anton Luht (JIRA)" <ji...@apache.org>.
[ 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
http://java.sun.com/j2se/javadoc/writingdoccomments/
Quote:
--
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 attached
--
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
[jira] Commented: (HARMONY-584) missing descriptions in @param tags
Posted by "Alexey Petrenko (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-584?page=comments#action_12420053 ]
Alexey Petrenko commented on HARMONY-584:
-----------------------------------------
Anton, will JavaDoc fail on such tags?
> missing descriptions in @param tags
> -----------------------------------
>
> Key: HARMONY-584
> URL: http://issues.apache.org/jira/browse/HARMONY-584
> Project: Harmony
> 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 attached
--
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
[jira] Updated: (HARMONY-584) missing descriptions in @param tags
Posted by "Anton Luht (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-584?page=all ]
Anton Luht updated HARMONY-584:
-------------------------------
Attachment: check_incorrect_param.sh
script to check problems
> missing descriptions in @param tags
> -----------------------------------
>
> Key: HARMONY-584
> URL: http://issues.apache.org/jira/browse/HARMONY-584
> Project: Harmony
> 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 attached
--
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