Skip to content

Commit 6c07b29

Browse files
committed
Javadoc
- Use a paragraph - Add @see tag
1 parent b5dbc45 commit 6c07b29

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java

+8-5
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,15 @@
2929
import org.apache.logging.log4j.util.PerformanceSensitive;
3030

3131
/**
32-
* This filter returns the onMatch result if the level in the LogEvent is the same or more specific
33-
* than the configured level and the onMismatch value otherwise. For example, if the ThresholdFilter
34-
* is configured with Level ERROR and the LogEvent contains Level DEBUG then the onMismatch value will
35-
* be returned since ERROR events are more specific than DEBUG.
32+
* This filter returns the onMatch result if the level in the {@link LogEvent} is the same or more specific
33+
* than the configured level and the {@code onMismatch} value otherwise. For example, if the ThresholdFilter
34+
* is configured with Level {@code ERROR} and the LogEvent contains Level {@code DEBUG} then the {@code onMismatch} value will
35+
* be returned since {@code ERROR} events are more specific than {@code DEBUG}.
36+
* <p>
37+
* The default Level is {@code ERROR}.
38+
* </p>
3639
*
37-
* The default Level is ERROR.
40+
* @see Level#isMoreSpecificThan(Level)
3841
*/
3942
@Configurable(elementType = Filter.ELEMENT_TYPE, printObject = true)
4043
@Plugin

0 commit comments

Comments
 (0)