Skip to content

Commit b500a6f

Browse files
committed
javadoc explaining using multiple markers instead of nested markers
Signed-off-by: Ceki Gulcu <ceki@qos.ch>
1 parent d81affb commit b500a6f

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

slf4j-api/src/main/java/org/slf4j/Marker.java

+10-3
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,11 @@
3333
* any markers are used, if at all. Many conforming logging systems ignore marker
3434
* data entirely.
3535
*
36-
* <p>Markers can contain references to other markers, which in turn may
37-
* contain references of their own.
36+
* <p>Markers can contain references to nested markers, which in turn may
37+
* contain references of their own. Note that the fluent API (new in 2.0) allows adding
38+
* multiple markers to a logging statement. It is often preferable to use
39+
* multiple markers instead of nested markers.
40+
* </p>
3841
*
3942
* @author Ceki G&uuml;lc&uuml;
4043
*/
@@ -59,7 +62,11 @@ public interface Marker extends Serializable {
5962

6063
/**
6164
* Add a reference to another Marker.
62-
*
65+
*
66+
* <p>Note that the fluent API allows adding multiple markers to a logging statement.
67+
* It is often preferable to use multiple markers instead of nested markers.
68+
* </p>
69+
*
6370
* @param reference
6471
* a reference to another marker
6572
* @throws IllegalArgumentException

0 commit comments

Comments
 (0)