Back to Error Prone

InvalidParam

docs/bugpattern/javadoc/InvalidParam.md

2.49.0421 B
Original Source

Javadoc's @param tag should not be used to document parameters which do not appear in the formal parameter list. This may indicate a typo, or an omission when refactoring.

java
/**
 * Parses {@code input} as a proto.
 *
 * @param inputBytes input bytes to parse.
 */
MyProto parse(byte[] input) {
  ...
}

Suppression

Suppress by applying @SuppressWarnings("InvalidParam") to the element being documented.