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

JavaDoc should support {@inheritDoc} for type parameters of class and interface declarations

XMLWordPrintable

      The {@inheritDoc} tag can be used to inherit the documention of corresponding elements in the super class or interface, reducing the amount of copying and pasting needed to document a hierarchy of classes. Unfortunately, {@inheritDoc} does not seem to work for type parameters, e.g.

      /**
       * @param <S> some type
       */
      class Parent<S> {...}

      /**
       * @param <S> {@inheritDoc}
       */
      class Child<S> extends Parent<S> {}

      doesn't produce any documentation for S in Child.

      This behavior would help encourage documenting the role of type parameters.

            prappo Pavel Rappo
            darcy Joe Darcy
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Imported:
              Indexed: