blob: 9233bb079ff00745e31ffa293f85620f58deab48 [file] [log] [blame] [view] [edit]
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.