[
https://issues.apache.org/jira/browse/HADOOP-6205?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Konstantin Boudnik updated HADOOP-6205:
---------------------------------------
Component/s: (was: scripts)
Description:
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.
was:
test-patch generated message usually includes a line
{noformat}
+1 javadoc. The javadoc tool did not generate any warning messages.
{noformat}
However the message is highly misleading, because the project code has tons of
JavaDoc's warnings and even errors. What the message should say is
"The javadoc tool did not generate new warning messages"
Issue Type: Improvement (was: Bug)
Summary: Project java code has a significant number of declaration
javadoc warnings and errors (was: test-patch provides misleading message about
JavaDoc warnings)
Sorry I think I should've better explain the problem.
I think those have nothing to do with the way test-patch does warnings
verification. I'm moving this bug into different category and changing its
description.
> 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
>
> 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.
