Skip to content

Commit

Permalink
Add more detailed suppression documentation to Finalize
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 515094442
  • Loading branch information
cushon authored and Error Prone Team committed Mar 8, 2023
1 parent 70942e0 commit 1b80a5e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/bugpattern/Finalize.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,12 @@ The [Google Java Style Guide §6.4][style] states:
[ej3e-8]: https://books.google.com/books?id=BIpDDwAAQBAJ
[style]: https://google.github.io/styleguide/javaguide.html#s6.4-finalizers

## Suppression

Suppress false positives by adding the suppression annotation to the enclosing
element:

```java
@SuppressWarnings("Finalize") // TODO(user): remove overrides of finalize
```

0 comments on commit 1b80a5e

Please sign in to comment.