JDK-4754029 : Doclet API: Rewrite doc comments in com.sun.javadoc.SeeTag
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.0
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS: other
  • CPU: generic
  • Submitted: 2002-09-26
  • Updated: 2014-05-05
  • Resolved: 2002-10-25
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
1.4.2 mantisFixed
Many of the doc comments in SeeTag are quite different from the actual
implementation and are also vague and incomplete.  For instance, the example
in referencedClassName() says that for @see String#startsWith(java.lang.String)
it returns String when it actually returns java.lang.String, and doesn't
mention what happens when @see references only a package name (the
package name is returned).

CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: mantis FIXED IN: mantis INTEGRATED IN: mantis mantis-b05

PUBLIC COMMENTS Revised the doc comments as suggested. No regression test required as this is a doc comment change. ###@###.### 2002-09-28

EVALUATION I spoke with Neal sometime back and he agreed with me it's too late to change the implementation to conform to the doc comments -- we should change the doc comments to conform to the implementation. We need to be careful not to over-specify things that we may want to change in the implementation. ###@###.### 2002-09-26