CODEWITHSUNDEEP
javajavadoc
mcfly soft
mcfly soft

Reputation: 11651

How to define Javadoc links, that can be accessed through clicking

I have defined a Javadoc comment as follow:

/**
 * bla bla bla {@link #PathAction} bla bla bla...
 * 
 * @author andreas
 *
 * @param <T>
 */

when moving the mouse on the object CustomPath in the java code I can see the following:

enter image description here

When clicking on the PathAction Link in the description , nothing happens. I expected that I was redirected to the PathAction Object.

Is this behaviour default or I am doing something wrong. Is there a way that I can be redirected to the PathAction Object, or how can I access the javadoc of PathAction. My goal is to read through the code with Javadoc comments.

any suggestions ?

Upvotes: 1

Views: 106

Answers (2)

M A
M A

Reputation: 72844

Remove the hash symbol in front of the class name. This is normally used when linking to methods. Also it would be better to use the fully qualified classname:

/**
 * bla bla bla {@link full.name.of.PathAction} bla bla bla...
 * 
 * @author andreas
 *
 * @param <T>
 */

Relevant documentation: http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDDIECH:

{@link package.class#member label}

Upvotes: 4

gsaslis
gsaslis

Reputation: 3166

Looks like you might be missing the package name?

Check this out: https://stackoverflow.com/a/7287411/983387

Upvotes: 1

Related Questions