19.2.11. {@value}
The {@valuestatic-field-name} tag is replaced by the actual value of the specified constant static
field. This tag uses the same member syntax as the @see tag. For example, if a doc comment contained the
text:
The valid range is 0 to {@value java.lang.Short#MAX_VALUE}.
Then the generated text would be
The valid range is 0 to 32767.
As a convenience, the value of the constant static field being documented can be referred to by {@value},
with no field name. For example, given
/* The default capacity of a new queue ({@value}). /
static final int DEFAULT_CAPACITY = 10;
the generated text would be
The default capacity of a new queue (10).
When specifying a particular field member, be careful not to leave any whitespace between the member name
and the closing } because it will be treated as part of the name.
All constant fields are documented on the "Constant Field Values" page, generated by the javadoc tool.
19.2.12. {@docRoot}
The files generated by javadoc are put into a tree, with subdirectories that contain parts of the
documentation. The exact placement of files in the tree is up to the javadoc implementation, and may
change depending on your environment, user preferences, and the like. You may want to add things to the tree
after it is built and then refer to those added pieces in your doc comments.
The in-line {@docRoot} tag lets you put into your doc comments a relative reference to other files in the
documentation tree. The {@docRoot} tag will be replaced with a relative path to the top of the generated
documentation tree. For example, the sentence
Check out our license.
would result in a sentence with a link to the file licenstemp0282.html in the root of the documentation
tree. After generating the documentation from the doc comments, you could copy
licenstemp0282.html into the top of the generated documentation tree, and the above link would
always go from the generated output to your licenstemp0282.html file. For some applications you may
find the mechanism described in "The doc-files Directory" on page 497 more useful.