Skip to content

Commit

Permalink
Clarify that @crv, when applied to a class, includes methods on inner…
Browse files Browse the repository at this point in the history
… classes.

I didn't think this was super obvious from the Javadoc; I wound up reading the implementation to check.

PiperOrigin-RevId: 428869499
  • Loading branch information
graememorgan authored and Error Prone Team committed Feb 15, 2022
1 parent a4291da commit 804cdbd
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
* when one of these methods is called but the result is not used.
*
* <p>{@code @CheckReturnValue} may be applied to a class or package to indicate that all methods in
* that class or package must have their return values checked. For convenience, we provide an
* annotation, {@link CanIgnoreReturnValue}, to exempt specific methods or classes from this
* behavior.
* that class (including indirectly; that is, methods of inner classes within the annotated class)
* or package must have their return values checked. For convenience, we provide an annotation,
* {@link CanIgnoreReturnValue}, to exempt specific methods or classes from this behavior.
*/
@Documented
@Target({METHOD, CONSTRUCTOR, TYPE, PACKAGE})
Expand Down

0 comments on commit 804cdbd

Please sign in to comment.