United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4754029 Doclet API: Rewrite doc comments in com.sun.javadoc.SeeTag
JDK-4754029 : Doclet API: Rewrite doc comments in com.sun.javadoc.SeeTag

Details
Type:
Bug
Submit Date:
2002-09-26
Status:
Resolved
Updated Date:
2002-10-25
Project Name:
JDK
Resolved Date:
2002-10-25
Component:
docs
OS:
other
Sub-Component:
doclet
CPU:
generic
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.0
Fixed Versions:
1.4.2 (mantis)

Related Reports

Sub Tasks

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).

                                    

Comments
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
                                     
2002-09-26
PUBLIC COMMENTS

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

BugTraq+ Release Management Values

COMMIT TO FIX:
mantis

FIXED IN:
mantis

INTEGRATED IN:
mantis
mantis-b05


                                     
2004-06-14



Hardware and Software, Engineered to Work Together