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)
======================================================================