Description Alex Blewitt 2003-05-25 09:50:27 EDT

I'd like to see a warning if I had a JavaDoc'd piece of code as follows:

/**
 * A description
 * @param first the first parameter
 */
public void method(Object first, Object second) {
}

-> Warning: @param 'second' missing from JavaDoc

Equally, it would be useful if the JavaDoc could also identify spurious doc
comments:
/**
 * A description
 * @param first the first parameter
 * @param second the second parameter
 * @param third the third parameter
 */
public void method(Object first, Object second) {
}
-> Warning: param 'third' missing

You could then be given an auto suggestion to add/delete the missing parameters
(or exception types) as appropriate.

Suitable linitan errors for JavaDoc could also include:
o Missing @version (if desired)
o Missing @author (if desired)
o Malformed HTML in JavaDoc quote
o Missing JavaDoc/non-JavaDoc comment above class/method/field

However, it would probably make sense for these options to be enabled/disabled
so that you don't always have such errors reported.