|
Quick Lists
|
|
Bug ID:
|
4214766
|
|
Votes
|
3
|
|
Synopsis
|
stddoclet: Consider making {@class} {@parent} {@package} {@member} standard tags
|
|
Category
|
doclet:tbd
|
|
Reported Against
|
1.2
|
|
Release Fixed
|
|
|
State
|
6-Fix Understood,
request for enhancement
|
|
Priority:
|
4-Low
|
|
Related Bugs
|
4282805
|
|
Submit Date
|
25-FEB-1999
|
|
Description
|
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)
======================================================================
|
|
Work Around
|
N/A
|
|
Evaluation
|
This suggestion sounds interesting. We need to discuss about this.
xxxxx@xxxxx 1999-02-24
Will investigate and fix for 1.4 beta.
xxxxx@xxxxx 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.
xxxxx@xxxxx 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}
stddoclet: Consider making {@class} {@parent} {@package} {@member} standard tags
Moved {@date} to a new request 4669046
xxxxx@xxxxx 2002-04-16
|
|
Comments
|
Submitted On 24-JAN-2003
mbeale
I think these standard tags would be great. However, direct
references to class names and such should be used sparingly
if you follow recommended javadoc sentence composition.
PLEASE NOTE: JDK6 is formerly known as Project Mustang
|
|
|
 |