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

Javadoc should expose covariant return type overrides

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • P3
    • 13
    • 11, 12, 13
    • tools
    • None
    • b23
    • generic
    • generic

    Backports

      Description

        Not showing which methods have covariant return type overrides hides some information from the user. For example, java.nio.MappedByteBuffer has some covariant return type overrides such as

            /**
             * {@inheritDoc}
             */
            @Override
            public final MappedByteBuffer reset() {
                super.reset();
                return this;
            }

        but reset(), et. al., show up under "Methods declared in class java.nio.Buffer". The hierarchy is MappedByteBuffer extends ByteBuffer extends Buffer extends Object.

        Attachments

          Issue Links

            backported by

            Backport - A issue that is required to port a Bug or Feature into another product release. This issue type is generally associated with the main Bug/Feature to represent each individual release of the port. JDK-8225821 Javadoc should expose covariant return type overrides

            • P3 - Major loss of function.
            • Resolved
            relates to

            Bug - A problem which impairs or prevents the functions of the product. JDK-8223607 --override-methods=summary ignores some signature changes

            • P3 - Major loss of function.
            • Resolved

            Enhancement - null JDK-4833719 (bf) Views of MappedByteBuffers are not MappedByteBuffers, and cannot be forced

            • P3 - Major loss of function.
            • Resolved

            Enhancement - null JDK-8157000 Do not generate javadoc for overridden method with no spec change

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

            Activity

              People

                jjg Jonathan Gibbons
                bpb Brian Burkhalter
                Votes:
                1 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: