Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4753737
Votes 2
Synopsis stddoclet: Allow {@value} to take field name arg and be used in any doc comment
Category doclet:tbd
Reported Against 1.4 , 1.4.1
Release Fixed
State 11-Closed, duplicate of 4764045, request for enhancement
Priority: 4-Low
Related Bugs 4754020 , 4764045
Submit Date 26-SEP-2002
Description
Currently {@value} can only be used in the doc comment of its own field,
to display the value.  It would be useful to be able to use it anywhere.
I am looking for a way to customize a series of Javadoc comments. Example:

/**
 * Names the property file.
 */
public static final String NAME_OF_PROPERTY_FILE = "db2.properties";

/**
 * This method reads the properties out of {@value NAME_OF_PROPERTY_FILE}
 */
 public void readProperties() {
 ...
 }

/**
 * This method writes the properties into {@value NAME_OF_PROPERTY_FILE}
 */
 public void writeProperties() {
 ...
 }

So if I need to change the value of the constant to
"cloudscape.properties" I wouldn't have to redo all the Javadoc
comments. (I came to this while doing a lot of Search/Replace)!
Work Around
N/A
Evaluation
Sounds useful.
  xxxxx@xxxxx   2002-09-26

Close out as a duplicate of:
4764045: javadoc inline tag {@value} should be available everywhere
  xxxxx@xxxxx   2002-12-03
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang