United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4745855 Erroneous "Parameter "foo" is documented more than once." warnings generated
JDK-4745855 : Erroneous "Parameter "foo" is documented more than once." warnings generated

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

Related Reports

Sub Tasks

Description
During a build of the coredocs target in the j2se workspace, over 3000 warning messages of the form
"Parameter "foo" is documented more than once."
are generated.  In the spot checks I've done *all* the messages are erroneous.

For example, in the message
/src/share/classes/java/lang/Comparable.java:117: warning - Parameter "o" is documented more than once.
the Comparable interface defines one method with one parameter and has one (correctly named) @param tag in the JavaDoc; there is nothing wrong.

In the Throwable class, warnings are issued for both

 public void printStackTrace(PrintStream s)
 public void printStackTrace(PrintWriter s)

The JavaDoc for both of these methods has a single properly named @param tag.

Erroneous warnings should not be issued.

                                    

Comments
EVALUATION

This bug has been fixed.  We recently added error checking for duplicate @param tags and @param tags with incorrectly spelled param names.  Our error checking didn't quite work but it has been fixed.  I greped for the erroneous warning messages in the output and it is no longer there.  The webrev is at:

http://frog.sfbay.sun.com/net/jano.sfbay/export/disk01/tools/doclets/stddoclet/webrevs/4745855-badParamWarn/webrev/

###@###.### 2002-09-12
                                     
2002-09-12
PUBLIC COMMENTS

This bug has been fixed.  The erroneous message is no longer printed.
                                     
2004-06-10
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