From 1068cd0eb9fb2460d368e3ba6112517ef3fedd2a Mon Sep 17 00:00:00 2001 From: Ceki Gulcu Date: Sat, 6 Aug 2022 23:25:49 +0200 Subject: [PATCH] javadoc changes Signed-off-by: Ceki Gulcu --- .../src/main/java/org/slf4j/helpers/CheckReturnValue.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/slf4j-api/src/main/java/org/slf4j/helpers/CheckReturnValue.java b/slf4j-api/src/main/java/org/slf4j/helpers/CheckReturnValue.java index 39ef64ceb..01f69d0b0 100644 --- a/slf4j-api/src/main/java/org/slf4j/helpers/CheckReturnValue.java +++ b/slf4j-api/src/main/java/org/slf4j/helpers/CheckReturnValue.java @@ -10,8 +10,14 @@ * which return an instance of LoggingEventBuilder (usually as this). Such * methods should be followed by one of the terminating log() methods returning * void.

+ *

+ *

IntelliJ IDEA supports a check for annotations named as CheckReturnValue + * regardless of the containing package. For more information on this feature in IntelliJ IDEA, select File → Setting → + * Editor → Inspections and then Java → Probable Bugs → Result of method call ignored.

+ *

* - *

Some IDEs such as IntelliJ IDEA support this annotation at compile time.

+ *

As for Eclipse, this feature has been requested in + * bug 572496

* * @author Ceki Gülcü * @since 2.0.0-beta1