United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4369014 : stddoclet: Using {@docRoot} tag disables use of {@link} tag

Details
Type:
Bug
Submit Date:
2000-09-07
Status:
Resolved
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2001-03-17
Component:
tools
OS:
windows_2000
Sub-Component:
javadoc(tool)
CPU:
x86
Priority:
P3
Resolution:
Fixed
Affected Versions:
1.3.0,1.3.1
Fixed Versions:
1.4.0 (beta)

Related Reports
Duplicate:

Sub Tasks

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



Hardware and Software, Engineered to Work Together