-
Enhancement
-
Resolution: Fixed
-
P3
-
7
-
b03
-
generic
-
generic
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 {...}
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 {...}
- relates to
-
JDK-4738591 stddoclet: Allow {@inheritDoc} to work with more tags
- Open
-
JDK-4810216 Allow {@inheritDoc name} for constructors
- Closed
-
JDK-6376959 Algorithm for Inheriting Method Comments seems to go not as documented
- Resolved
-
JDK-8285368 Overhaul doc-comment inheritance
- Resolved
-
JDK-4957169 Please provide full details about where a method is specified in multiple-inheritance interfaces
- Closed
-
JDK-6386502 allow more flexible inclusion and cross referencing of doc comments
- Open
(1 relates to, 2 links to)