United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4851991 : {@docroot} in -bottom causes broken link for help-doc.html

Details
Type:
Bug
Submit Date:
2003-04-22
Status:
Resolved
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2003-09-26
Component:
tools
OS:
other
Sub-Component:
javadoc(tool)
CPU:
generic
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.2
Fixed Versions:
5.0 (tiger)

Related Reports

Sub Tasks

Description
{@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.

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
tiger

FIXED IN:
tiger

INTEGRATED IN:
tiger
tiger-b22


                                     
2004-06-14
PUBLIC COMMENTS

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.
###@###.### 2003-05-04
                                     
2003-05-04
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.
###@###.### 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.
###@###.### 2003-05-04
                                     
2003-05-04



Hardware and Software, Engineered to Work Together