Improve documentation of nullability on LoggingEvent interface

Signed-off-by: Hermann Mørkrid <[email protected]>
qos-ch · Dec 27, 2024 · 8d551b7 · 8d551b7
1 parent 0def25e
commit 8d551b7
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/slf4j-api/src/main/java/org/slf4j/event/LoggingEvent.java b/slf4j-api/src/main/java/org/slf4j/event/LoggingEvent.java
@@ -17,24 +17,27 @@ public interface LoggingEvent {
 
     String getLoggerName();
 
+    /** Log message, might be null. */
     String getMessage();
 
+    /** List of arguments in the event, might be null. */
     List<Object> getArguments();
 
+    /** Array of arguments in the event, might be null. */
     Object[] getArgumentArray();
 
-    /**
-     * List of markers in the event, might be null.
-     * @return markers in the event, might be null.
-     */
+    /** List of markers in the event, might be null. */
     List<Marker> getMarkers();
 
+    /** List of key-value pairs in the event, might be null. */
     List<KeyValuePair> getKeyValuePairs();
 
+    /** Cause exception, might be null. */
     Throwable getThrowable();
 
     long getTimeStamp();
 
+    /** Name of thread that made the log, might be null. */
     String getThreadName();
 
     /**