JDK-4745855 : Erroneous "Parameter "foo" is documented more than once." warnings generated
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.2
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS: generic
  • CPU: generic
  • Submitted: 2002-09-11
  • Updated: 2014-05-05
  • Resolved: 2002-10-25
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
1.4.2 mantisFixed
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.

CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: mantis FIXED IN: mantis INTEGRATED IN: mantis mantis-b05

PUBLIC COMMENTS This bug has been fixed. The erroneous message is no longer printed.

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