Hadoop Common
  1. Hadoop Common
  2. HADOOP-6205

Project java code has a significant number of declaration javadoc warnings and errors

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      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.

      1. Eclipse-JavaDoc-errors.png
        122 kB
        Konstantin Boudnik

        Issue Links

          Activity

          No work has yet been logged on this issue.

            People

            • Assignee:
              Konstantin Boudnik
              Reporter:
              Konstantin Boudnik
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development