hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Konstantin Boudnik (JIRA)" <j...@apache.org>
Subject [jira] Updated: (HADOOP-6205) Project java code has a significant number of declaration javadoc warnings and errors
Date Wed, 26 Aug 2009 02:26:59 GMT

     [ https://issues.apache.org/jira/browse/HADOOP-6205?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Konstantin Boudnik updated HADOOP-6205:
---------------------------------------

    Attachment: Eclipse-JavaDoc-errors.png

To reproduce the same situation in the Eclipse it needs to be configured as show in the attachment.
These settings reveal 1000+ issues with missing tags or fields/parameters which can't be resolved.
And this is for {{public}} methods only

If missing tags might be considered as a warnings then unresolvable parameters have to be
looked upon as errors and addressed accordingly.

I can't find how to reproduce this analysis with JavaDoc+javac tools yet..

I'm going to attach the list of 'unresolved parameters' for future consideration.

> Project java code has a significant number of declaration javadoc warnings and errors
> -------------------------------------------------------------------------------------
>
>                 Key: HADOOP-6205
>                 URL: https://issues.apache.org/jira/browse/HADOOP-6205
>             Project: Hadoop Common
>          Issue Type: Improvement
>            Reporter: Konstantin Boudnik
>            Assignee: Konstantin Boudnik
>         Attachments: Eclipse-JavaDoc-errors.png
>
>
> The issue here is that code inspections (say by IntelliJ IDEA) show that a number of
classes have javadoc problems in declarations. Some of those are minor, e.g. missing @return,
@param, @throws tags.
> Some of them are more severe, e.g. using non-existing parameter names in a method javadoc
(see HDFS' BlockManager.removeFromInvalidates(..) for an example)
> I'd like to add more sophisticated code analysis to be able to fix at least javadoc declaration
errors in order to produce better code quality.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message