-
Enhancement
-
Resolution: Won't Fix
-
P4
-
None
-
1.4.0
-
generic
-
generic
If a method overrides a method whose documentation comment includes an @see tag,
then there appears to be no way for the overriding method to suppress the 'See
Also' reference in its documentation. This behavior seems to be a result of the
new features for inheriting documentation introduced in the 1.4 release.
Here's a simple test case:
public class InheritDocProblem {
/** @see #goo */
public void foo() { }
/** @see #foo */
public void goo() { }
public static class Inner extends InheritDocProblem {
/** Don't want See Also here. */
public void foo() { }
/** Or here!
* @see
*/
public void goo() { }
}
}
The resulting javadoc looks like:
foo
public void foo()
Don't want See Also here.
Overrides:
foo in class InheritDocProblem
See Also:
InheritDocProblem.goo()
------------------------------------------------------------------------
goo
public void goo()
Or here!
Overrides:
goo in class InheritDocProblem
See Also:
------------------------------------------------------------------------
then there appears to be no way for the overriding method to suppress the 'See
Also' reference in its documentation. This behavior seems to be a result of the
new features for inheriting documentation introduced in the 1.4 release.
Here's a simple test case:
public class InheritDocProblem {
/** @see #goo */
public void foo() { }
/** @see #foo */
public void goo() { }
public static class Inner extends InheritDocProblem {
/** Don't want See Also here. */
public void foo() { }
/** Or here!
* @see
*/
public void goo() { }
}
}
The resulting javadoc looks like:
foo
public void foo()
Don't want See Also here.
Overrides:
foo in class InheritDocProblem
See Also:
InheritDocProblem.goo()
------------------------------------------------------------------------
goo
public void goo()
Or here!
Overrides:
goo in class InheritDocProblem
See Also:
------------------------------------------------------------------------