Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[eclipse-pmc] API request: [polish] adding a sub-option for unused parameter warning

JDT/Core would like to request a new field constant addition:

This constant is identifying a new preference for better controlling the
unused parameter optional warning.
The compiler is currently detecting too many false positives when enabling
the unused parameter warning, and this got identified as a top request for
the polish effort.

Current situation is that there is no way to let the compiler know that an
apparent unused parameter is actually mandated by some API contract (for
subclasses to override).
The proposal is to allow such parameters to be documented as such, simply
by using Javadoc @param tags (i.e. if parameter is referenced from Javadoc,
then stop complaining). This behavior would be made optional, and
conditioned by this new preference.

- allow to get rid of false positive unused parameter warnings by letting
user document these in Javadoc.



No risk, all API additions. The master preference for detecting unused
parameter is OFF by default, so the suboption has no impact by default.


No performance impact.

Back to the top