Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4369014
Votes 1
Synopsis stddoclet: Using {@docRoot} tag disables use of {@link} tag
Category doclet:tbd
Reported Against 1.3 , 1.3.1
Release Fixed 1.4(merlin-beta)
State 10-Fix Delivered, bug
Priority: 3-Medium
Related Bugs 4650903
Submit Date 07-SEP-2000
Description
Bug found in method com.sun.tools.javadoc.Comment.inlineTagImplFound().  Bug had been fixed.

 xxxxx@xxxxx  2001-01-09Steps:
      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)
Work Around
N/A
Evaluation
This is fairly serious, as it results in a broken link (and thus inaccessible data.)
 xxxxx@xxxxx  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.
 xxxxx@xxxxx  2001-01-09
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang