File: InvalidParam.md

package info (click to toggle)
error-prone-java 2.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 23,204 kB
  • sloc: java: 222,992; xml: 1,319; sh: 25; makefile: 7
file content (19 lines) | stat: -rw-r--r-- 422 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
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.