Javadoc @see object method
I would like to link a method of another object using @see from a comment block
@see is only giving me the option to link classes, not methods.
What is the hack?
public class A {
B bee;
/**
* Just invoking methodB on bee.
* @see B.methodB() <-- There
*/
public methodA() {
bee.methodB();
}
}
public class B {
/**
* The real stuff
*/
public methodB() {
// real stuff
}
}
Use hashes instead of dots, as in: @see B#methodB()
You need to use # instead of .
@see B#methodB()
See the documentation for @see
here.