[HADOOP-6205] Project java code has a significant number of declaration javadoc warnings and errors

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Won't Fix
• Assignee: Konstantin I Boudnik
• Reporter: Konstantin I Boudnik
• Created: 20/Aug/09 19:44
• Updated: 20/Mar/12 04:15
• Resolved: 20/Mar/12 04:15

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.

Issue Links

• incorporates: HDFS-571 Hdfs source code has significant number of JavaDocs errors and warnings
• incorporates: MAPREDUCE-914 MapReduce source code has significant number of JavaDocs errors and warnings