Skip to content

Commit

Permalink
javadoc explaining using multiple markers instead of nested markers
Browse files Browse the repository at this point in the history
Signed-off-by: Ceki Gulcu <[email protected]>
  • Loading branch information
ceki committed Sep 26, 2022
1 parent d81affb commit b500a6f
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions slf4j-api/src/main/java/org/slf4j/Marker.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@
* any markers are used, if at all. Many conforming logging systems ignore marker
* data entirely.
*
* <p>Markers can contain references to other markers, which in turn may
* contain references of their own.
* <p>Markers can contain references to nested markers, which in turn may
* contain references of their own. Note that the fluent API (new in 2.0) allows adding
* multiple markers to a logging statement. It is often preferable to use
* multiple markers instead of nested markers.
* </p>
*
* @author Ceki G&uuml;lc&uuml;
*/
Expand All @@ -59,7 +62,11 @@ public interface Marker extends Serializable {

/**
* Add a reference to another Marker.
*
*
* <p>Note that the fluent API allows adding multiple markers to a logging statement.
* It is often preferable to use multiple markers instead of nested markers.
* </p>
*
* @param reference
* a reference to another marker
* @throws IllegalArgumentException
Expand Down

0 comments on commit b500a6f

Please sign in to comment.