Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8285368 Overhaul doc-comment inheritance
  3. JDK-8325320

Release Note: The `inheritDoc` Tag and Method Comments Algorithm Have Been Changed

    XMLWordPrintable

Details

    Description

      An optional parameter has been added to the `inheritDoc` tag so that an author can specify the supertype from which to search for inherited documentation. Additionally, the algorithm to search for inherited documentation has been modified to better align with the method inheriting and overriding rules in Java Language Specification.

      For more details, see the following sections of the Documentation Comment Specification for the Standard Doclet:

        - [Method Documentation](https://docs.oracle.com/en/java/javase/22/docs/specs/javadoc/doc-comment-spec.html#method-documentation)
        - [`{@inheritDoc}`](https://docs.oracle.com/en/java/javase/22/docs/specs/javadoc/doc-comment-spec.html#inheritdoc)

      Attachments

        Activity

          People

            prappo Pavel Rappo
            prappo Pavel Rappo
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: