This is an automated email from the ASF dual-hosted git repository. pkarwasz pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit ba8f243be97f4117c46c5043f344e95de9d4c644 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Thu Nov 2 19:56:24 2023 +0100 Fix remaining Javadoc errors in `log4j-api` --- log4j-api/src/main/java/org/apache/logging/log4j/Level.java | 1 + log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java | 2 +- .../org/apache/logging/log4j/message/FormattedMessageFactory.java | 5 +++-- .../org/apache/logging/log4j/message/LocalizedMessageFactory.java | 5 +++-- .../apache/logging/log4j/message/MessageFormatMessageFactory.java | 5 +++-- .../apache/logging/log4j/message/ParameterizedMessageFactory.java | 5 +++-- .../log4j/message/ParameterizedNoReferenceMessageFactory.java | 5 +++-- .../java/org/apache/logging/log4j/message/SimpleMessageFactory.java | 5 +++-- .../org/apache/logging/log4j/message/StringFormattedMessage.java | 5 +++-- .../apache/logging/log4j/message/StringFormatterMessageFactory.java | 5 +++-- .../java/org/apache/logging/log4j/spi/LoggingSystemProperty.java | 2 +- .../main/java/org/apache/logging/log4j/util/StackLocatorUtil.java | 2 +- log4j-api/src/main/java/org/apache/logging/log4j/util/Unbox.java | 3 ++- 13 files changed, 30 insertions(+), 20 deletions(-) diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/Level.java b/log4j-api/src/main/java/org/apache/logging/log4j/Level.java index 88eb7b9244..8a44ed332b 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/Level.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/Level.java @@ -28,6 +28,7 @@ import static org.apache.logging.log4j.util.Strings.toRootUpperCase; /** * Levels used for identifying the severity of an event. Levels are organized from most specific to least: * <table> + * <caption>Levels</caption> * <tr> * <th>Name</th> * <th>Description</th> diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java b/log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java index e4287d883d..25e01cf7a4 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/ThreadContext.java @@ -38,7 +38,7 @@ import org.apache.logging.log4j.util.Strings; * The ThreadContext allows applications to store information either in a Map or a Stack. * <p> * <b><em>The MDC is managed on a per thread basis</em></b>. To enable automatic inheritance of <i>copies</i> of the MDC - * to newly created threads, enable the {@value LoggingSystemProperty#THREAD_CONTEXT_MAP_INHERITABLE} + * to newly created threads, enable the {@link LoggingSystemProperty#THREAD_CONTEXT_MAP_INHERITABLE} * Log4j system property. * </p> * @see <a href="https://logging.apache.org/log4j/2.x/manual/thread-context.html";>Thread Context Manual</a> diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/FormattedMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/FormattedMessageFactory.java index abb2979f76..8488be2149 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/FormattedMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/FormattedMessageFactory.java @@ -19,8 +19,9 @@ package org.apache.logging.log4j.message; /** * Creates {@link FormattedMessage} instances for {@link MessageFactory} methods. * - * <h3></h3> - * <h4>Note to implementors</h4> + * <p> + * <strong>Note to implementors:</strong> + * </p> * <p> * This class implements all {@link MessageFactory} methods. * </p> diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/LocalizedMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/LocalizedMessageFactory.java index 91f66b0abb..dcfc7624ec 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/LocalizedMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/LocalizedMessageFactory.java @@ -21,8 +21,9 @@ import java.util.ResourceBundle; /** * Creates {@link FormattedMessage} instances for {@link MessageFactory} methods. * - * <h3></h3> - * <h4>Note to implementors</h4> + * <p> + * <strong>Note to implementors:</strong> + * </p> * <p> * This class does <em>not</em> implement any {@link MessageFactory} methods and lets the superclass funnel those calls * through {@link #newMessage(String, Object...)}. diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/MessageFormatMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/MessageFormatMessageFactory.java index 7d4fe23de6..dfef142739 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/MessageFormatMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/MessageFormatMessageFactory.java @@ -19,8 +19,9 @@ package org.apache.logging.log4j.message; /** * Creates {@link FormattedMessage} instances for {@link MessageFactory} methods. * - * <h3></h3> - * <h4>Note to implementors</h4> + * <p> + * <strong>Note to implementors:</strong> + * </p> * <p> * This class implements all {@link MessageFactory} methods. * </p> diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessageFactory.java index a4f05fd717..e1666a2773 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessageFactory.java @@ -28,8 +28,9 @@ package org.apache.logging.log4j.message; * This class is immutable. * </p> * - * <h3></h3> - * <h4>Note to implementors</h4> + * <p> + * <strong>Note to implementors:</strong> + * </p> * <p> * This class implements all {@link MessageFactory} methods. * </p> diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedNoReferenceMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedNoReferenceMessageFactory.java index 007ce19d85..225eecc78b 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedNoReferenceMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedNoReferenceMessageFactory.java @@ -30,8 +30,9 @@ import org.apache.logging.log4j.status.StatusLogger; * <p> * This class is immutable. * </p> - * <h3></h3> - * <h4>Note to implementors</h4> + * <p> + * <strong>Note to implementors:</strong> + * </p> * <p> * This class does <em>not</em> implement any {@link MessageFactory} methods and lets the superclass funnel those calls * through {@link #newMessage(String, Object...)}. diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/SimpleMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/SimpleMessageFactory.java index 9426a76e9e..60bf6a6e54 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/SimpleMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/SimpleMessageFactory.java @@ -29,8 +29,9 @@ package org.apache.logging.log4j.message; * This class is immutable. * </p> * - * <h3></h3> - * <h4>Note to implementors</h4> + * <p> + * <strong>Note to implementors:</strong> + * </p> * <p> * This class implements all {@link MessageFactory} methods. * </p> diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormattedMessage.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormattedMessage.java index 995726286b..df197e39d2 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormattedMessage.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormattedMessage.java @@ -27,8 +27,9 @@ import org.apache.logging.log4j.status.StatusLogger; /** * Handles messages that consist of a format string conforming to {@link java.util.Formatter}. * - * <h3></h3> - * <h4>Note to implementors</h4> + * <p> + * <strong>Note to implementors:</strong> + * </p> * <p> * This class implements the unrolled args API even though StringFormattedMessage does not. This leaves the room for * StringFormattedMessage to unroll itself later. diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormatterMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormatterMessageFactory.java index 8e0bc66384..f79cf5307c 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormatterMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormatterMessageFactory.java @@ -27,8 +27,9 @@ package org.apache.logging.log4j.message; * <p> * This class is immutable. * </p> - * <h3></h3> - * <h4>Note to implementors</h4> + * <p> + * <strong>Note to implementors:</strong> + * </p> * <p> * This class implements all {@link MessageFactory} methods. * </p> diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggingSystemProperty.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggingSystemProperty.java index 418ab4cd19..70f61693fe 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggingSystemProperty.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggingSystemProperty.java @@ -126,7 +126,7 @@ public enum LoggingSystemProperty implements PropertyKey { /** * Property to enable TRACE-level debug logging in the Log4j system itself. * <p> - * If property {@value} is either defined empty or its value equals to {@code true} (ignoring case), all internal + * If the property is either defined empty or its value equals to {@code true} (ignoring case), all internal * logging will be printed to the console. The presence of this system property overrides any value set in the * configuration's {@code <Configuration status="<level>" ...>} status attribute. * </p> diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/StackLocatorUtil.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/StackLocatorUtil.java index 062976146a..4f0947113d 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/StackLocatorUtil.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/StackLocatorUtil.java @@ -23,7 +23,7 @@ import java.util.function.Predicate; import org.apache.logging.log4j.status.StatusLogger; /** - * <em>Consider this class private.</em> Provides various methods to determine the caller class. <h3>Background</h3> + * <em>Consider this class private.</em> Provides various methods to determine the caller class. */ @InternalApi public final class StackLocatorUtil { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/Unbox.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/Unbox.java index 701b29b1b6..d9022a6fef 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/Unbox.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/Unbox.java @@ -41,7 +41,8 @@ import org.apache.logging.log4j.status.StatusLogger; * have up to 32 boxed primitives in a single logger call. * </p> * <p> - * If more slots are required, set system property {@value LoggingSystemProperty#UNBOX_RING_BUFFER_SIZE} to the desired ring buffer size. + * If more slots are required, set system property {@link LoggingSystemProperty#UNBOX_RING_BUFFER_SIZE} to the desired + * ring buffer size. * Note that the specified number will be rounded up to the nearest power of 2. * </p> * @since 2.6
