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

Support directed inheriting of class comments with @inheritDoc

    XMLWordPrintable

Details

    • b03
    • generic
    • generic

    Description

      The utility of @inheritDoc would be improved if documentation from supertypes could be selectively inherited for a class or interface declaration in addition to information for methods. This would greatly ease the maintenance of javadoc for many kinds of APIs.

      For example, it would be helpful to be able to write javadoc like the following:

      /**
       * All about A.
       */
      class A {...}

      /**
       * Some specific information about B.
       * {@inheritDoc A}
       * Some more information specific to B.
       * {@inheritDoc I}
       */
      class B extends A implements I {...}

      Attachments

        Issue Links

          Activity

            People

              prappo Pavel Rappo
              darcy Joe Darcy
              Votes:
              1 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: