Escribiendo javadoc con @see?

Question

¿Cómo uso correctamente el javadoc @see?

Mi intención es tener una clase abstracta con métodos abstractos. Estos métodos tienen comentarios javadoc. Ahora, si extiendo la clase abstracta, anulo los métodos y quiero usar @see.

Pero para todos los parámetros, por ejemplo, para return, el enlace @see no parece funcionar. Eclipse todavía se queja de que expected @return tag.

Entonces, ¿cómo puedo usar esto?

public abstract class MyBase { 
    protected abstract void myFunc(); 
} 

class MyImpl extends MyBase { 

    /** 
    * @see MyBase#myFunc() 
    */ 
    @Override 
    protected void myFunc() { .. } 
} 

Answer 1

Para el propósito de incluir la documentación de una superclase se debe utilizar {@inheritDoc} no @see.

se obtiene la documentación de la superclase. Puede agregar algo, y puede anular cosas como @param y @return si es necesario.

public abstract class MyBase { 
    /** 
    * @param id The id that will be used for... 
    * @param good ignored by most implementations 
    * @return The string for id 
    */ 
    protected abstract String myFunc(Long id, boolean good); 
} 

class MyImpl extends MyBase { 

    /** 
    * {@inheritDoc} 
    * @param good is used differently by this implementation 
    */ 
    @Override 
    protected String myFunc(Long id, boolean good) { .. } 
}