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

Do not generate javadoc for overridden method with no spec change

    XMLWordPrintable

Details

    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

          blocks

          Bug - A problem which impairs or prevents the functions of the product. JDK-8189706 javadoc for the JDK APIs should summarize overridden methods with no specification changes

          • P3 - Major loss of function.
          • Resolved
          csr for

          CSR - null JDK-8187386 Do not generate javadoc for overridden method with no spec change

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Closed
          duplicates

          Enhancement - null JDK-8205590 API Documentation should include one more tab for "added methods"

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Closed
          relates to

          Bug - A problem which impairs or prevents the functions of the product. JDK-8296607 Review and specify no-spec-change overrides

          • P3 - Major loss of function.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. JDK-8190436 Bug in VisibleMemberMap, including non-deterministic behavior

          • P3 - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8219147 Javadoc should expose covariant return type overrides

          • P3 - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8029891 Deadlock detected in java/lang/ClassLoader/deadlock/GetResource.java

          • P3 - Major loss of function.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. JDK-8198890 The standard doclet incorrectly produces wrong method signatures in certain cases.

          • P3 - Major loss of function.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. JDK-8037423 @treatAsPrivate should hide the member for sub classes

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. JDK-8189845 Fix for 8157000 causes significant performance regression

          • P2 - Crashes, loss of data, severe memory leak.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8264217 Overriding method with absent spec is not mentioned as overriding in the JavaSE class specification

          • P2 - Crashes, loss of data, severe memory leak.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8199281 Broken link in nav bar "Summary: ... METHOD" when it points to inherited methods of super class.

          • P3 - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8271485 Javadoc "Method Summary" table is misaligned if overridden JDK method has {@inheritDoc} tag

          • P3 - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8249070 @inheritDoc does not work if standalone

          • P3 - Major loss of function.
          • Closed

          Activity

            People

              ksrini Kumar Srinivasan
              mchung Mandy Chung
              Votes:
              0 Vote for this issue
              Watchers:
              9 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: