United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4621267 Doclet API: ProgramElementDoc.qualifiedName() lacks parameter list - fix docs
JDK-4621267 : Doclet API: ProgramElementDoc.qualifiedName() lacks parameter list - fix docs

Details
Type:
Bug
Submit Date:
2002-01-09
Status:
Resolved
Updated Date:
2002-10-26
Project Name:
JDK
Resolved Date:
2002-10-26
Component:
docs
OS:
generic
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

Name: rmT116609			Date: 01/09/2002


java version "1.4.0-beta3"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-beta3-b84)
Java HotSpot(TM) Client VM (build 1.4.0-beta3-b84, mixed mode)


 DESCRIPTION OF THE PROBLEM :

The documentation for ProgramElementDoc.qualifiedName() says that it will return "Foo.bar()" for the bar() method of the
Foo class in the unnamed package. However, it actually returns "Foo.bar". This is not used anywhere in the standard
doclet, and can be worked around by using (elt.qualifiedName()+((ExecutableMemberDoc)elt).signature()).
 Fixing the documentation would be as effective as fixing the method.


(Review ID: 138105) 
======================================================================

                                    

Comments
EVALUATION

Looks like changing the doc comment is the backward compatible way to go.
###@###.### 2002-03-22

Changed synopsis from:
   ExecutableMemberDoc.qualifiedName() lacks signature - fix the docs
to:
   ExecutableMemberDoc.qualifiedName() lacks parameter list - fix docs
                                     
2002-03-22
PUBLIC COMMENTS

Fixed by removing parentheses from bar() 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