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: 4760191
Votes 3
Synopsis stddoclet: A first sentence {@docRoot} link is broken in single-page index
Category doclet:tbd
Reported Against mantis
Release Fixed 1.5(tiger-b30)
State 10-Fix Delivered, bug
Priority: 4-Low
Related Bugs 4828483
Submit Date 09-OCT-2002
Description
Fixed.
 xxxxx@xxxxx  2003-11-15The first sentence of a package, class or member contains {@docRoot} 
appears in the alphabetic index as a kind of a summary.  If that index
is generated *without* -splitindex, that {@docRoot} link is broken.

For example, for a first sentence in a class comment that links
to the package summary page, if the original first sentence is:

<A HREF="{@docRoot}/p1/package-summary.html#tests">To package tests</A>

I expect to get this in the index-all.html file:

<A HREF="./p1/package-summary.html#tests">To package tests</A>

but instead get this:

<A HREF="/p1/package-summary.html#tests">To package tests</A>
Work Around
N/A
Evaluation
Fix for Tiger.  I've already written the test for index-all.html in
the DocRootSlash.java test file, but have yet to write the fix.
 xxxxx@xxxxx  2002-10-08

The SingleIndexWriter.java source file uses a constructor that does
not set the relativepath field, while SplitIndexWriter.java does.
 xxxxx@xxxxx  2002-10-09

Fixed by initializing the relativepath field.
 xxxxx@xxxxx  2003-11-15
Comments
  
  Include a link with my name & email   

Submitted On 15-DEC-2002
dobratzp
I've encountered this bug as well.  A workaround is to prefix the {@docRoot} with an extra "./"  In your example, this reduces to .//p1/package-summary.html#tests
The extra "/" is needed though so that links from other pages work correctly.  Additionally, for the index-add.html page and friends, the link works correctly although it's technically not correct.
Once the javadoc tool gets fixed to correctly insert a "." for these pages, this workaround will be superfluous, but still not get in the way.



PLEASE NOTE: JDK6 is formerly known as Project Mustang