JDK-4738591 : stddoclet: Allow {@inheritDoc} to work with more tags
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.0
  • Priority: P4
  • Status: Open
  • Resolution: Unresolved
  • OS: other
  • CPU: generic
  • Submitted: 2002-08-29
  • Updated: 2024-04-12
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
Other
tbdUnresolved
Related Reports
Duplicate :  
Relates :  
Description
It would be useful to use {@inheritDoc} more widely.

Currently, the {@inheritDoc} tag can only be used 
in these specific places:
 - in the text portion of @return, @throws and @param tags
 - in method comments

Other inheritance takes place automatically.
If and only if a Doc object does not have any @see tags of its own,
it inherits @see text from a class or interface from higher in the 
inheritance.  There is no support for inheriting other tags such as 
@since, @deprecated, etc.

The question arises:

1) Shall we extend {@inheritDoc} to work in constructors?  
   (Constructors do no inherit functionality)

2) Should we allow {@inheritDoc} in be used in any of the other 
   tags: @see, @deprecated, @since or @serialData?
   I can see where someone might want to inherit text 
   for @see and add more references:

   @see {@inheritDoc}, java.lang.String

3) Should we allow {@inheritDoc} to work for main descriptions
   or tags in class and interface comments?

Is it true that methods with @serialData are private, so 
{@inheritDoc} wouldn't apply there?

Note:  The above request is about an explicit {@inheritDoc}
tag.  Bug 4646560 is a request for automatic inheritance 
to also work with @deprecated like for @return, @param, 
@throws and @see.


Comments
> Should we allow {@inheritDoc} to work for main descriptions > or tags in class and interface comments? That now partially and unofficially works for some tags, thanks to JDK-8008768.
29-04-2022

CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: dragon
14-06-2004

EVALUATION Need to consider. ###@###.### 2002-11-24 spainhou on WED APR 16 05:43 A.M. 2003 spainhou on Bug Parade says: I really support number 3, consider the case of inheriting docs from abstract classes of interfaces. We use a standard that all comments are placed at the interface level and that the class that implements the interface would not need comments. Please consider. ###@###.### 2003-04-17
17-04-2003