Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8157000

Do not generate javadoc for overridden method with no spec change

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: 9
    • Fix Version/s: 10
    • Component/s: tools

      Description

      By default javadoc is generated for a method if it overrides a method defined in its supertype.

      When a method is overridden with no change in semantic behavior, javadoc currently lists it in the primary method summary just with @inheritdoc. It is not that useful. When many methods are overridden, including inherited docs for these methods in the primary method summary is just noise. Keeping them in "Methods inherited from ..." section would be adequate.

      Perhaps javadoc should not bother listing overridden methods that do not have any comment provided to document any change of semantic behavior.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                ksrini Kumar Srinivasan
                Reporter:
                mchung Mandy Chung
              • Votes:
                0 Vote for this issue
                Watchers:
                8 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: