United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-6967036 Need to fix links with // in Javadoc comments
JDK-6967036 : Need to fix links with // in Javadoc comments

Details
Type:
Bug
Submit Date:
2010-07-06
Status:
Resolved
Updated Date:
2014-02-21
Project Name:
JDK
Resolved Date:
2014-02-21
Component:
infrastructure
OS:
generic
Sub-Component:
build
CPU:
generic
Priority:
P3
Resolution:
Won't Fix
Affected Versions:
6u21
Fixed Versions:
6-pool

Related Reports
Backport:
Backport:

Sub Tasks

Description
Javadoc comments have links with "//" in them instead of "/". 
On oracle.com, this causes certain urls to be crawled and indexed with // instead of /.
When searching on download.oracle.com (Oracle's documentation web site), the search engine returns results with // in the urls. When you open a url with //, the relative links in the page are broken. This is most obvious because the branding elements such as css files cannot be referenced. Other relative links may be broken too.
Removing the // from the url and re-loading the page fixes the problem.

This is a real problem because more pages are affected than just the ones with //. The search crawler indexes certain paths with // and all pages under that directory are then returned with // in the url.

This problem is likely to be magnified when Javadoc LAF is enhanced  to use stylesheets. 

A list of urls with // is attached. This list is NOT exhaustive.

JDK 6 api doc
-------------
several references to tools//

// converted to / in ../../../../javax/naming/ldap/ftp://ftp.isi.edu/in-notes/rfc2251.txt
    occurred in
    /../docs/api/javax/naming/ldap/class-use/ExtendedResponse.html
    /../docs/api/javax/naming/ldap/class-use/HasControls.html
    /api/javax/naming/ldap/class-use/ExtendedResponse.html

// converted to / in ../../../../technotes/guides//security/jsse/JSSERefGuide.html#AppA
    occurred in
    /../docs/api/javax/net/ssl/SSLContext.html
    /api/javax/net/ssl/SSLContext.html

// converted to / in ../../../javax/naming/ldap/ftp://ftp.isi.edu/in-notes/rfc2251.txt
    occurred in
    /../docs/api/javax/naming/ldap/package-use.html
    /../docs/api/javax/naming/ldap/package-use.html
    /../docs/api/javax/naming/ldap/package-use.html
    /../docs/api/javax/naming/ldap/package-use.html

// converted to / in http://ietf.org//rfc/rfc2253.txt
    occurred in
    /../docs/api/java/lang/class-use/Object.html
    /../docs/api/java/lang/class-use/Object.html
    /../docs/api/javax/naming/class-use/Name.html
    /../docs/api/javax/naming/ldap/LdapName.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/package-summary.html
    /../docs/jre/api/security/jaas/spec/com/sun/security/auth/LdapPrincipal.html
    /../docs/jre/api/security/jaas/spec/com/sun/security/auth/package-summary.html
    /../docs/jre/api/security/jaas/spec/index-all.html
    /api/java/lang/class-use/Object.html
    /api/java/lang/class-use/Object.html
    /api/javax/naming/ldap/LdapName.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/package-summary.html
    /jre/api/security/jaas/spec/com/sun/security/auth/LdapPrincipal.html
    /jre/api/security/jaas/spec/com/sun/security/auth/package-summary.html
    /jre/api/security/jaas/spec/index-all.html

// converted to / in http://www.omg.org//docs/formal/99-10-07.pdf
    occurred in
    /../docs/technotes/guides/idl/POA.html

JDK 7 API doc
-------------

several references to tools//

// converted to / in ../../../../javax/naming/ldap/ftp://ftp.isi.edu/in-notes/rfc2251.txt
    occurred in
    /../docs/api/javax/naming/ldap/class-use/ExtendedResponse.html
    /../docs/api/javax/naming/ldap/class-use/HasControls.html
    /api/javax/naming/ldap/class-use/ExtendedResponse.html

// converted to / in ../../../../technotes/guides//security/jsse/JSSERefGuide.html#AppA
    occurred in
    /../docs/api/javax/net/ssl/SSLContext.html
    /api/javax/net/ssl/SSLContext.html

// converted to / in ../../../javax/naming/ldap/ftp://ftp.isi.edu/in-notes/rfc2251.txt
    occurred in
    /../docs/api/javax/naming/ldap/package-use.html
    /../docs/api/javax/naming/ldap/package-use.html
    /../docs/api/javax/naming/ldap/package-use.html
    /../docs/api/javax/naming/ldap/package-use.html

// converted to / in http://ietf.org//rfc/rfc2253.txt
    occurred in
    /../docs/api/java/lang/class-use/Object.html
    /../docs/api/java/lang/class-use/Object.html
    /../docs/api/javax/naming/class-use/Name.html
    /../docs/api/javax/naming/ldap/LdapName.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/Rdn.html
    /../docs/api/javax/naming/ldap/package-summary.html
    /../docs/jre/api/security/jaas/spec/com/sun/security/auth/LdapPrincipal.html
    /../docs/jre/api/security/jaas/spec/com/sun/security/auth/package-summary.html
    /../docs/jre/api/security/jaas/spec/index-all.html
    /api/java/lang/class-use/Object.html
    /api/java/lang/class-use/Object.html
    /api/javax/naming/ldap/LdapName.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/Rdn.html
    /api/javax/naming/ldap/package-summary.html
    /jre/api/security/jaas/spec/com/sun/security/auth/LdapPrincipal.html
    /jre/api/security/jaas/spec/com/sun/security/auth/package-summary.html
    /jre/api/security/jaas/spec/index-all.html

// converted to / in http://www.omg.org//docs/formal/99-10-07.pdf
    occurred in
    /../docs/technotes/guides/idl/POA.html

                                    

Comments
EVALUATION

Not clear we need to fix this in 6u23 or a 6 update unless we re-generate docs.
                                     
2010-07-14
EVALUATION

Confirmed with Sowmya, this is not a must fix for 6u23, and likely not for 6u25 either.   I've untargeted this from a specific 6 update to the 6-pool.
                                     
2010-12-01
Resolved in 7 & 8, not needed for jdk6 updates.
                                     
2014-02-21



Hardware and Software, Engineered to Work Together