United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4359874 : stddoclet: -linkoffline mistakenly inserts '\' instead of '/' in URL on Windows

Details
Type:
Bug
Submit Date:
2000-08-04
Status:
Resolved
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2001-03-17
Component:
tools
OS:
solaris_2.6
Sub-Component:
javadoc(tool)
CPU:
sparc
Priority:
P3
Resolution:
Fixed
Affected Versions:
1.2.0
Fixed Versions:
1.4.0 (beta)

Related Reports
Relates:

Sub Tasks

Description
I am observing a behavior in JavaDoc which I would classify as a bug.
However, it might be that I'm missing something.

I'm using -linkoffline option for enabling links from my documentation to the
standard JDK classes. This option accepts extdocURL parameter which it uses
as a prefix for making hyperlinks to the external documentation. After that a
pathname separator is placed and a path to the specific HTML page. I'm
running JavaDoc on Windows NT. Because of this (I guess) JavaDoc uses
backslash (\) as a separator between the basepath to the ext docs and the
tail. 

For example, if my class com.mycompany.mypackage.MyClass extends
javax.swing.JTable, and assuming I run javadoc -linkoffline ../JDK/docs/api
/JDK/docs/api, the result would be:
../../../../JDK/docs/api\javax/swing/JTable.html Pay attention to the
backslash in the middle. Everything would be nice, were Windows NT the only
platform in the world. This is, however, not true. For reasons, not relevant
to this discussion, I'm using Apache on Unix as a Web server for viewing the
generated documentation. Since use of backslash is not standard in HTML,
links of this kind do not work. Would be happy to hear a possible workaround.

Technical info:

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)

javadoc -d \Qbuild\doc -sourcepath \Q
     -classpath \Qbuild\class
     -linkoffline ../JDK/docs/api /JDK/docs/api <package-name>
(the command is split into lines for readability)

Thank you for your attention.

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
merlin-beta

FIXED IN:
merlin-beta

INTEGRATED IN:
merlin-beta


                                     
2004-06-14
PUBLIC COMMENTS

I have fixed this bug.

jamie.ho@Eng 2001-02-28
                                     
2001-02-28
EVALUATION

Important for Windows users, as it causes broken links.
doug.kramer@Eng 2000-09-07

I have fixed this bug.  Location of bug fix:

Extern.adjustEndFileSeparator()

jamie.ho@Eng 2001-02-28
                                     
2000-09-07



Hardware and Software, Engineered to Work Together