JDK-4214766 : stddoclet: Consider making {@class} {@parent} {@package} {@member} standard tags
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0
  • Priority: P4
  • Status: Closed
  • Resolution: Won't Fix
  • OS: generic
  • CPU: generic
  • Submitted: 1999-02-25
  • Updated: 2024-10-09
  • Resolved: 2013-12-19
Related Reports
Relates :  
Description
Name: vi73552			Date: 02/24/99


I have suggestions for new tags for javadoc. 
These tags would expand to a string when javadoc builds the html file.

{@class}  The name of the current class.
{@parent}  The name of the parent class, if this class is derived from another.
{@package}  The name of the package this class belongs to.

Also consider
{@member}

Example:

/** The {@class} class is used for ...
  * ...other classes derived from {@parent}.
  * ...any class in the {@package} package.
*/

This would expand to:

The square3d class is used for ...
...other classes derived from square.
...any class in the com.mystuff.shape package.

These tags would allow comments to be portable. I find that I
often write comments that I copy and paste into a similar class.
These tags would save the work of changing class names after copying.

.........
The {@date} tag was moved to request 4669046

{@date format}  The date that the documentation was build. format could somehow specify the format of the date that appears.

  * This documentation was last updated on {@date MMM DD, YYYY}.

(Review ID: 54352) 
======================================================================

Comments
This can be done using custom tags in javadoc.
19-12-2013

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

EVALUATION This suggestion sounds interesting. We need to discuss about this. atul.dambalkar@eng 1999-02-24 Will investigate and fix for 1.4 beta. jamie.ho@Eng 2001-05-14 These tags can be added to Javadoc by the user after 4282805 is implemented. I will close this bug as a duplicate. jamie.ho@Eng 2001-06-14 Some of these tags should be considered as standard tags, so am re-opening this request and changing the synopsis from: stddoclet: New tags for portable comments: {@class} {@parent} {@package} {@date} to: stddoclet: Consider making {@class} {@parent} {@package} {@member} standard tags Moved {@date} to a new request 4669046 ###@###.### 2002-04-16
16-04-2002

PUBLIC COMMENTS These tags can be added to Javadoc by the user after 4282805 is implemented. I will close this bug as a duplicate. jamie.ho@Eng 2001-06-14
14-06-2001