File: InvalidThrows.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 (18 lines) | stat: -rw-r--r-- 339 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
The `@throws` tag should not document a checked exception which is not actually
thrown by the documented method.

```java
/**
 * Validates {@code n}.
 *
 * @throws Exception if n is negative.
 */
void validate(int n) {
  ...
}
```

## Suppression

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