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: 4851991
Votes 0
Synopsis {@docroot} in -bottom causes broken link for help-doc.html
Category doclet:tbd
Reported Against mantis-beta
Release Fixed 1.5(tiger)
State 10-Fix Delivered, bug
Priority: 4-Low
Related Bugs
Submit Date 22-APR-2003
Description
This bug has been fixed for the 1.5 release.  The {@docRoot} tag now resolves to "." instead of empty string when used in files that are stored in the root directory.
 xxxxx@xxxxx  2003-05-04{@docroot} resolves to the empty string "" in the help-doc.html page when used 
with the -bottom option.  It should resolve to a dot "." character.

In this makefile that runs javadoc:
   <ws>/make/docs/Makefile

the -bottom option contains this string:

For further API reference and developer documentation, see <a href="{@docroot}/../relnotes/devdocs-vs-specs.html">Java 2 SDK SE Developer Documentation</a>. 

The URL resolves in api/hel-doc.html to:
 <a href="/../relnotes/devdocs-vs-specs.html">

and should instead resolve to:
 <a href="./../relnotes/devdocs-vs-specs.html">

The link to the license terms in that same -bottom option in help-doc.html
is also broken the same way:
 
   Use is subject to <a href="/../relnotes/license.html">license terms</a>.

Changing it to a dot "." fixes it.
Work Around
N/A
Evaluation
This might be due to {@docroot} not being spelled {@docRoot} (capital 'R'), 
but it resolves to the correct value on class pages.  For example, 
on api/javax/swing/AbstractAction.html, {@docroot} resolves in the
first URL to the proper value "../.." in:

   <a href="../../../relnotes/devdocs-vs-specs.html">

I recall when fixing this problem for other pages, I had to set the
relative path for those pages.  The fix to this problem is probably
to set the relative path for help-doc.html, and to ensure it is
set properly for all other pages (particularly non-class pages).

Be sure to add test cases for all of the pages that are fixed.
 xxxxx@xxxxx  2003-04-22

This bug has been fixed.  The problem was that member relativepathNoSlash was initialized with "".  It should be initialized with ".".  I will mark this bug as fixed when the doclet toolkit is checked into the TL workspace.
 xxxxx@xxxxx  2003-05-04
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang