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: 4802275
Votes 1
Synopsis @param should be printed even if first argument is incorrect - REGRESSION
Category doclet:tbd
Reported Against 1.4
Release Fixed 1.5(tiger-b30)
State 10-Fix Delivered, bug
Priority: 3-Medium
Related Bugs
Submit Date 13-JAN-2003
Description
When a doc comment is written, the first argument to @param should match one of
the method parameters.  In 1.4.2, if it does not match in spelling and case,
then @param is not printed.  This causes important parts of the spec to
disappear when a user upgrades to 1.4.  This is a mistake, and is contrary to 
how javadoc worked prior to 1.4.  

Instead @param should be printed with the misspelled argument, as in most cases,
the user can correlate the misspelled @param argument to the correct method
parameter, and benefit from reading the @param description.

For example, in constructor BeansContextServicesSupport:

    /**
     * ...
     * @param dtime The initial state, true if in design mode, false if runtime.
     * ...
     */
    public BeanContextServicesSupport(BeanContextServices peer, Locale lcle, boolean dTime, boolean visible) {
	super(peer, lcle, dTime, visible);
    }

The first argument "dtime" is not capitalized properly, so neither it nor
its description is printed.  It should be printed as-is.
Here is the parameter printout:

Parameters:
   peer - The peer BeanContext we are supplying an implementation for, 
      if null the this  customer  is its own peer
   lcle - The current Locale for this BeanContext.
   visible - The initial visibility.

This is the current warning for the above error:

/java/pubs/ws/mantis/make/docs/../../src/share/classes/java/beans/beancontext/BeanContextServicesSupport.java:59: warning - @param argument "dtime" is not a parameter name.
Work Around
N/A
Evaluation
Important, as it prevents part of the spec from printing.
  xxxxx@xxxxx   2003-01-13

Fixed.
  xxxxx@xxxxx   2003-11-15
Comments
  
  Include a link with my name & email   

Submitted On 14-OCT-2003
rachna_chadha2001
Thats right ! I am waiting for this bug to be fixed.



PLEASE NOTE: JDK6 is formerly known as Project Mustang