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: 4745855
Votes 0
Synopsis Erroneous "Parameter "foo" is documented more than once." warnings generated
Category doclet:tbd
Reported Against mantis
Release Fixed 1.4.2(mantis)
State 10-Fix Delivered, bug
Priority: 4-Low
Related Bugs
Submit Date 11-SEP-2002
Description
This bug has been fixed.  The erroneous message is no longer printed.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.
Work Around
N/A
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/

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


PLEASE NOTE: JDK6 is formerly known as Project Mustang