JDK-4369014 : stddoclet: Using {@docRoot} tag disables use of {@link} tag
  • Type: Bug
  • Status: Resolved
  • Resolution: Fixed
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Priority: P3
  • Affected Version: 1.3.0,1.3.1
  • OS: windows_2000
  • CPU: x86
  • Submit Date: 2000-09-07
  • Updated Date: 2014-05-05
  • Resolved Date: 2001-03-17
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availabitlity Release.

To download the current JDK release, click here.
Other
1.4.0 betaResolved
Related Reports
Duplicate :  
Description
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)

Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: merlin-beta FIXED IN: merlin-beta INTEGRATED IN: merlin-beta
2004-06-14

EVALUATION This is fairly serious, as it results in a broken link (and thus inaccessible data.) doug.kramer@Eng 2000-09-07 Bug found in method com.sun.tools.javadoc.Comment.inlineTagImplFound(). Forgot to handle case where @docRoot is used. Incorrectly assumed that @link is only type of inline tag that can be found. Bug had been fixed. jamie.ho@Eng 2001-01-09
2001-01-09

PUBLIC COMMENTS Bug found in method com.sun.tools.javadoc.Comment.inlineTagImplFound(). Bug had been fixed. jamie.ho@Eng 2001-01-09
2001-01-09