Javadoc @link

javadoc

I wrote two methods in class Util:

public static final <T> T[] copy1(T[] source) {...}
public static final <T> T[] copy2(T[] source) {...}

Javadoc for method copy2 includes:

{@link #copy1(Object[]) copy}

and as a test includes also:

{@link Integer#highestOneBit(int) highestOneBit}

When I click the highestOneBit link it works.
When I click the copy link, it doesnt work correctly, it links to the Util class?!
Java version 1.5.0_16.

Best Answer

What happens when you link to copy(T[]) instead of copy(Object[])? On my machine, that works.

Related Solutions

Java – Multiple line code example in Javadoc comment

In addition to the already mentioned <pre> tags, you should also use the @code JavaDoc annotation, which will make life much easier when it comes to HTML entities issues (in particular with Generics), e.g.:

* <pre>
* {@code
* Set<String> s;
* System.out.println(s);
* }
* </pre>

Will give correct HTML output:

Set<String> s;
System.out.println(s);

While omitting the @code block (or using a <code> tag) will result in HTML like this:

Set s;
System.out.println(s);

For reference, a full list of tag descriptions available in Java SE 8 can be found here.

Java – Linking to an external URL in Javadoc

This creates a "See Also" heading containing the link, i.e.:

/**
 * @see <a href="http://google.com">http://google.com</a>
 */

will render as:

See Also:
http://google.com

whereas this:

/**
 * See <a href="http://google.com">http://google.com</a>
 */

will create an in-line link:

See http://google.com

Best Answer

Related Solutions

Java – Multiple line code example in Javadoc comment

Java – Linking to an external URL in Javadoc

Related Topic