You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gg...@apache.org on 2024/11/05 13:00:20 UTC

(logging-log4j2) 02/02: Javadoc

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git

commit 6c07b299ba92f97d37b64dbd2a918716055d6d40
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Nov 5 08:00:12 2024 -0500

    Javadoc
    
    - Use a paragraph
    - Add @see tag
---
 .../apache/logging/log4j/core/filter/ThresholdFilter.java   | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
index 12cff3d153..3f050618b2 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
@@ -29,12 +29,15 @@ import org.apache.logging.log4j.plugins.PluginFactory;
 import org.apache.logging.log4j.util.PerformanceSensitive;
 
 /**
- * This filter returns the onMatch result if the level in the LogEvent is the same or more specific
- * than the configured level and the onMismatch value otherwise. For example, if the ThresholdFilter
- * is configured with Level ERROR and the LogEvent contains Level DEBUG then the onMismatch value will
- * be returned since ERROR events are more specific than DEBUG.
+ * This filter returns the onMatch result if the level in the {@link LogEvent} is the same or more specific
+ * than the configured level and the {@code onMismatch} value otherwise. For example, if the ThresholdFilter
+ * is configured with Level {@code ERROR} and the LogEvent contains Level {@code DEBUG} then the {@code onMismatch} value will
+ * be returned since {@code ERROR} events are more specific than {@code DEBUG}.
+ * <p>
+ * The default Level is {@code ERROR}.
+ * </p>
  *
- * The default Level is ERROR.
+ * @see Level#isMoreSpecificThan(Level)
  */
 @Configurable(elementType = Filter.ELEMENT_TYPE, printObject = true)
 @Plugin