Bug #3795
closed
Broken javadoc links
100%
Description
Some javadoc links in the documentation come from {@link} markup in the Java comments. If the class name is only given in abbreviated form, rather than the fully qualified class name, then the link does not work in the interactive XML documentation.
e.g. the first paragraph at http://www.saxonica.com/documentation/index.html#!javadoc/net.sf.saxon.z/IntToIntArrayMap is
"An implementation of IntToIntMap that relies on serial searching, and is therefore optimized for very small map sizes" which contains a link for IntToIntMap, but this doesn't work. (Note there is working link directly above because IntToIntMap is the implemented interface).
Links should be given as package.class#member (see https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#link).
https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#package.class says:
"This package.class#member name can be either fully-qualified, such as java.lang.String#toUpperCase() or not, such as String#toUpperCase() or #toUpperCase()."
So the different forms are:
-
Referencing a member of the current class, e.g. #method(Type, Type,...)
-
Referencing another class in the current or imported packages, e.g. Class#method(Type argname, Type argname,...)
-
Referencing an element in another package (fully qualified), e.g. package.Class#constructor(Type, Type,...)
It seems that we handle cases 1 and 3, but not 2. See <xsl:template match="tag[@kind]" mode="jdc"> in jdc-body.xsl.
Please register to edit this issue
.