JDK-4283169 : stddoclet: Add {@super} tag for copying the doc comment from a superclass
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0,1.3.0
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • OS: solaris_2.6,solaris_8
  • CPU: generic,sparc
  • Submitted: 1999-10-20
  • Updated: 2020-08-31
  • Resolved: 2001-06-29
Related Reports
Duplicate :  
JDK-4186639 - stddoclet: Inherit documentation with {@inheritDoc} tag
Duplicate :  
JDK-4372211 - stddoclet: option to *not* copy superclass documentation
Description
Add {@super} tag that copies the doc comment from a superclass
into the current doc comment.  This allows developers to 
write around the copied text rather than have that be the 
only text.  

Currently, text is copied only if the comment is empty.  
(I explained this is the current behavior before asking 
them to vote for this tag, to ensure they were voting for 
the tag, not simply the inheritance feature.)
Comments
EVALUATION This is a fine idea and simple. It should be an inline tag {@super}. robert.field@Eng 1999-10-20 Picked up comment from RFE 4372211 for option to *never* copy superclass documentation, so only subclass docs appear. doug.kramer@Eng 2000-12-08 This is a dupe of 4186639, for {@inheritDoc}. Closing this out. doug.kramer@Eng 2001-06-29
08-12-2000