Steps:
1. Create a Javadoc comment that uses the {@docRoot} tag.
2. Place a {@link} tag somewhere after the {@docRoot} tag.
3. Run Javadoc tool on source that includes the comment
4. In the resulting documentation, the {@link} tag is not resolved to
HTML; instead it appears in its literal state.
Source code:
/**
* Here is the use of link: {@link somepackage.someClass someClass}
* Here is the use of docRoot: <a href="{@docRoot}/glossary.html">glossary</a>.
* Here is the use of link: {@link somepackage.someClass someClass}
*/
This will produce documentation like this:
"Here is the use of link: someClass.
Here is the use of docRoot: glossary.
Here is the use of link: {@link somepackage.someClass someClass}"
Environment:
OS: Windows 2000
Version:
java version "1.3.0"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.0-C)
Java HotSpot(TM) Client VM (build 1.3.0-C, mixed mode)