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

          Konstantin Boudnik created issue -
          Konstantin Boudnik made changes -
          Field Original Value New Value
          Issue Type Bug [ 1 ] Improvement [ 4 ]
          Summary test-patch provides misleading message about JavaDoc warnings Project java code has a significant number of declaration javadoc warnings and errors
          Description 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"
          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.
          Component/s scripts [ 12311393 ]
          Konstantin Boudnik made changes -
          Assignee Konstantin Boudnik [ cos ]
          Konstantin Boudnik made changes -
          Attachment Eclipse-JavaDoc-errors.png [ 12417697 ]
          Konstantin Boudnik made changes -
          Link This issue incorporates HDFS-571 [ HDFS-571 ]
          Konstantin Boudnik made changes -
          Link This issue is blocked by MAPREDUCE-914 [ MAPREDUCE-914 ]
          Konstantin Boudnik made changes -
          Link This issue incorporates MAPREDUCE-914 [ MAPREDUCE-914 ]
          Konstantin Boudnik made changes -
          Link This issue is blocked by MAPREDUCE-914 [ MAPREDUCE-914 ]
          Konstantin Boudnik made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Resolution Won't Fix [ 2 ]

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Development