Name: jl125535 Date: 12/04/2001


ava version "1.4.0-beta3"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-beta3-b84)
Java HotSpot(TM) Client VM (build 1.4.0-beta3-b84, mixed mode)

Please revise the documentation for the @value tag in
  http://java.sun.com/j2se/1.4/docs/tooldocs/javadoc/whatsnew-1.4.html#{@value}.
  and
  http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/javadoc.html#{@value}

to indicate for which member fields the @value tag is appropriate.
(It also would be nice to offer suggestions on proper use of this
new feature, since the temptation to expose too much of the
implementation is high.)

In the report below, the customer expects to be able to use
"@value" for any member field, as long as "tag" refers to
a constant. My reading of the documentation is that "@value"
is designed for final member fields.

--------------------------

With javadoc, generate docu for the following:
public class t
{
  static final int c = 1;
  /**
   * {@value c}
   */
  public int cc;
}
It complains with: warning - Inline tag {@value} should only be used with a
constant field.


I base my understanding on the description of @value in
http://java.sun.com/j2se/1.4/docs/tooldocs/javadoc/whatsnew-1.4.html#{@value}.
and
http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/javadoc.html#{@value}

Given the tag "{@value name}", I expect name to be the name of any constant,
so the above should work, shoudn't it?
(Review ID: 136627)
======================================================================