Escrevendo javadoc adequado com @see?
Como eu uso o@see
javadoc corretamente?
Minha intenção é ter uma classe abstrata com métodos abstratos. Esses métodos possuem comentários do javadoc. Agora, se eu estender a classe abstrata, eu sobrescrevo os métodos e quero usar@see
.
Mas para todos os params, por exemplo, parareturn
a@see
link parece não funcionar. Eclipse ainda reclama queexpected @return tag
.
Então, como posso usar isso?
public abstract class MyBase {
protected abstract void myFunc();
}
class MyImpl extends MyBase {
/**
* @see MyBase#myFunc()
*/
@Override
protected void myFunc() { .. }
}