Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4754029
Votes 0
Synopsis Doclet API: Rewrite doc comments in com.sun.javadoc.SeeTag
Category doclet:tbd
Reported Against 1.4
Release Fixed 1.4.2(mantis)
State 10-Fix Delivered, bug
Priority: 4-Low
Related Bugs
Submit Date 26-SEP-2002
Description
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).
Work Around
N/A
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.

  xxxxx@xxxxx   2002-09-26
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang