You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by pk...@apache.org on 2023/11/02 19:45:56 UTC
(logging-log4j2) branch main updated (c031a93a2a -> b5fadaea6d)
This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
from c031a93a2a Generate a `test-jar` for `log4j-layout-jackson`
new 3389ee7482 Switch to official Maven Javadoc plugin properties
new 9f45b062b3 Remove invalid javadoc links
new 1378c15b9a Add missing javadoc tags
new ba8f243be9 Fix remaining Javadoc errors in `log4j-api`
new b5fadaea6d Fix remaining Javadoc errors in `log4j-core`
The 5 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
log4j-api/pom.xml | 2 +-
log4j-api/src/main/java/org/apache/logging/log4j/Level.java | 1 +
.../src/main/java/org/apache/logging/log4j/ThreadContext.java | 2 +-
.../apache/logging/log4j/message/FormattedMessageFactory.java | 5 +++--
.../apache/logging/log4j/message/LocalizedMessageFactory.java | 5 +++--
.../logging/log4j/message/MessageFormatMessageFactory.java | 5 +++--
.../logging/log4j/message/ParameterizedMessageFactory.java | 5 +++--
.../log4j/message/ParameterizedNoReferenceMessageFactory.java | 5 +++--
.../apache/logging/log4j/message/SimpleMessageFactory.java | 5 +++--
.../apache/logging/log4j/message/StringFormattedMessage.java | 5 +++--
.../logging/log4j/message/StringFormatterMessageFactory.java | 5 +++--
.../org/apache/logging/log4j/message/StructuredDataId.java | 2 +-
.../org/apache/logging/log4j/spi/LoggingSystemProperty.java | 2 +-
.../java/org/apache/logging/log4j/util/StackLocatorUtil.java | 2 +-
.../src/main/java/org/apache/logging/log4j/util/Unbox.java | 3 ++-
log4j-core/pom.xml | 2 +-
.../log4j/core/appender/AbstractOutputStreamAppender.java | 6 +++++-
.../logging/log4j/core/appender/AbstractWriterAppender.java | 10 +++++++++-
.../apache/logging/log4j/core/appender/FailoverAppender.java | 2 +-
.../org/apache/logging/log4j/core/appender/NullAppender.java | 2 +-
.../apache/logging/log4j/core/appender/SocketAppender.java | 4 ++--
.../log4j/core/appender/db/AbstractDatabaseAppender.java | 4 +---
.../logging/log4j/core/appender/rewrite/RewriteAppender.java | 2 +-
.../log4j/core/appender/rolling/action/DeleteAction.java | 4 ++--
.../core/appender/rolling/action/IfAccumulatedFileSize.java | 2 +-
.../log4j/core/appender/rolling/action/SortingVisitor.java | 5 ++---
.../logging/log4j/core/async/AsyncQueueFullPolicyFactory.java | 6 ++++--
.../log4j/core/async/DiscardingAsyncQueueFullPolicy.java | 2 +-
.../java/org/apache/logging/log4j/core/config/Property.java | 2 +-
.../apache/logging/log4j/core/filter/StringMatchFilter.java | 6 +++---
.../apache/logging/log4j/core/impl/ContextDataFactory.java | 2 +-
.../org/apache/logging/log4j/core/impl/ExtendedClassInfo.java | 6 +++---
.../logging/log4j/core/impl/ExtendedStackTraceElement.java | 2 +-
.../logging/log4j/core/impl/ThreadContextDataInjector.java | 2 +-
.../org/apache/logging/log4j/core/layout/AbstractLayout.java | 4 ++--
.../main/java/org/apache/logging/log4j/core/net/Facility.java | 1 +
.../logging/log4j/core/pattern/NamePatternConverter.java | 1 -
.../java/org/apache/logging/log4j/core/time/ClockFactory.java | 2 +-
.../org/apache/logging/log4j/core/time/InstantFormatter.java | 2 +-
.../log4j/core/time/internal/format/FastDateParser.java | 3 ++-
.../apache/logging/log4j/core/tools/picocli/CommandLine.java | 10 +++++-----
.../java/org/apache/logging/log4j/core/util/Constants.java | 8 ++++----
.../org/apache/logging/log4j/core/util/CronExpression.java | 3 ++-
.../org/apache/logging/log4j/core/util/ProcessIdUtil.java | 2 +-
.../apache/logging/log4j/core/util/StringBuilderWriter.java | 2 +-
log4j-parent/pom.xml | 2 +-
pom.xml | 11 ++++-------
47 files changed, 98 insertions(+), 78 deletions(-)
(logging-log4j2) 03/05: Add missing javadoc tags
Posted by pk...@apache.org.
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 1378c15b9aad31da021fba06051e5e66b265cb0d
Author: Lukasz Spyra <lu...@gmail.com>
AuthorDate: Fri Oct 6 17:25:27 2023 +0200
Add missing javadoc tags
Most of the missing tags are self-explanatory, added a few missing to be consistent
---
.../org/apache/logging/log4j/message/StructuredDataId.java | 2 +-
.../log4j/core/appender/AbstractOutputStreamAppender.java | 6 +++++-
.../logging/log4j/core/appender/AbstractWriterAppender.java | 10 +++++++++-
3 files changed, 15 insertions(+), 3 deletions(-)
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataId.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataId.java
index 76937ba298..3e22a3d136 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataId.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataId.java
@@ -90,7 +90,7 @@ public class StructuredDataId implements StringBuilderFormattable {
* @param name The name portion of the id.
* @param required The list of keys that are required for this id.
* @param optional The list of keys that are optional for this id.
- * @param maxLength The maximum length of the id.
+ * @param maxLength The maximum length of the id's name.
* @since 2.9
*/
public StructuredDataId(final String name, final String[] required, final String[] optional, int maxLength) {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractOutputStreamAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractOutputStreamAppender.java
index d1b7402797..ebfcb95b1e 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractOutputStreamAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractOutputStreamAppender.java
@@ -93,7 +93,11 @@ public abstract class AbstractOutputStreamAppender<M extends OutputStreamManager
*
* @param name The name of the Appender.
* @param layout The layout to format the message.
- * @param properties Optional properties.
+ * @param filter The filter to associate with the Appender.
+ * @param ignoreExceptions If true, exceptions will be logged and suppressed.
+ * If false errors will be logged and then passed to the application.
+ * @param immediateFlush Underlying output stream will be flushed at the end of each append operation.
+ * @param properties optional properties
* @param manager The OutputStreamManager.
*/
protected AbstractOutputStreamAppender(final String name, final Layout layout,
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractWriterAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractWriterAppender.java
index 14379ca560..d22d3490e3 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractWriterAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractWriterAppender.java
@@ -54,7 +54,15 @@ public abstract class AbstractWriterAppender<M extends WriterManager> extends Ab
* The name of the Appender.
* @param layout
* The layout to format the message.
- * @param properties Optional properties.
+ * @param filter
+ * The filter to associate with the Appender.
+ * @param ignoreExceptions
+ * If true, exceptions will be logged and suppressed.
+ * If false errors will be logged and then passed to the application.
+ * @param immediateFlush
+ * Underlying writer will be flushed at the end of each append operation.
+ * @param properties
+ * Optional properties.
* @param manager
* The OutputStreamManager.
*/
(logging-log4j2) 05/05: Fix remaining Javadoc errors in `log4j-core`
Posted by pk...@apache.org.
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 b5fadaea6d97ea5d272953996066ca43fa7d764d
Author: Piotr P. Karwasz <pi...@karwasz.org>
AuthorDate: Thu Nov 2 20:45:47 2023 +0100
Fix remaining Javadoc errors in `log4j-core`
---
.../apache/logging/log4j/core/appender/FailoverAppender.java | 2 +-
.../org/apache/logging/log4j/core/appender/NullAppender.java | 2 +-
.../org/apache/logging/log4j/core/appender/SocketAppender.java | 4 ++--
.../log4j/core/appender/db/AbstractDatabaseAppender.java | 4 +---
.../logging/log4j/core/appender/rewrite/RewriteAppender.java | 2 +-
.../log4j/core/appender/rolling/action/DeleteAction.java | 4 ++--
.../core/appender/rolling/action/IfAccumulatedFileSize.java | 2 +-
.../log4j/core/appender/rolling/action/SortingVisitor.java | 5 ++---
.../logging/log4j/core/async/AsyncQueueFullPolicyFactory.java | 6 ++++--
.../log4j/core/async/DiscardingAsyncQueueFullPolicy.java | 2 +-
.../java/org/apache/logging/log4j/core/config/Property.java | 2 +-
.../apache/logging/log4j/core/filter/StringMatchFilter.java | 6 +++---
.../org/apache/logging/log4j/core/impl/ContextDataFactory.java | 2 +-
.../logging/log4j/core/impl/ThreadContextDataInjector.java | 2 +-
.../org/apache/logging/log4j/core/layout/AbstractLayout.java | 4 ++--
.../main/java/org/apache/logging/log4j/core/net/Facility.java | 1 +
.../logging/log4j/core/pattern/NamePatternConverter.java | 1 -
.../java/org/apache/logging/log4j/core/time/ClockFactory.java | 2 +-
.../org/apache/logging/log4j/core/time/InstantFormatter.java | 2 +-
.../apache/logging/log4j/core/tools/picocli/CommandLine.java | 10 +++++-----
.../java/org/apache/logging/log4j/core/util/Constants.java | 8 ++++----
.../org/apache/logging/log4j/core/util/CronExpression.java | 3 ++-
.../java/org/apache/logging/log4j/core/util/ProcessIdUtil.java | 2 +-
.../apache/logging/log4j/core/util/StringBuilderWriter.java | 2 +-
24 files changed, 40 insertions(+), 40 deletions(-)
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/FailoverAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/FailoverAppender.java
index ab2130a052..16d738f129 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/FailoverAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/FailoverAppender.java
@@ -176,7 +176,7 @@ public final class FailoverAppender extends AbstractAppender {
* @param retryIntervalSeconds The retry interval in seconds.
* @param config The current Configuration (passed by the Configuration when the appender is created).
* @param filter A Filter (optional).
- * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise
+ * @param ignoreExceptions If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise
* they are propagated to the caller.
* @return The FailoverAppender that was created.
*/
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/NullAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/NullAppender.java
index 204ee96bf0..d083e4eb78 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/NullAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/NullAppender.java
@@ -26,7 +26,7 @@ import org.apache.logging.log4j.plugins.PluginFactory;
/**
* An Appender that ignores log events. Use for compatibility with version 1.2 and handy for composing a
- * {@link ScriptAppenderSelector}.
+ * {@code ScriptAppenderSelector}.
*/
@Configurable(elementType = Appender.ELEMENT_TYPE, printObject = true)
@Plugin(NullAppender.PLUGIN_NAME)
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
index e175f4cf14..10fe05b1b5 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
@@ -51,12 +51,12 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
/**
* Subclasses can extend this abstract Builder.
- * <h1>Defaults</h1>
+ * <h2>Defaults</h2>
* <ul>
* <li>host: "localhost"</li>
* <li>protocol: "TCP"</li>
* </ul>
- * <h1>Changes</h1>
+ * <h2>Changes</h2>
* <ul>
* <li>Removed deprecated "delayMillis", use "reconnectionDelayMillis".</li>
* <li>Removed deprecated "reconnectionDelay", use "reconnectionDelayMillis".</li>
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseAppender.java
index fb14bf1694..9e713054cd 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/AbstractDatabaseAppender.java
@@ -31,9 +31,7 @@ import org.apache.logging.log4j.core.config.Property;
/**
* An abstract Appender for writing events to a database of some type, be it relational or NoSQL. All database appenders
- * should inherit from this base appender. Three implementations are currently provided:
- * {@link org.apache.logging.log4j.core.appender.db.jdbc JDBC}, {@link org.apache.logging.log4j.core.appender.db.jpa
- * JPA}, and {@link org.apache.logging.log4j.core.appender.nosql NoSQL}.
+ * should inherit from this base appender.
*
* @param <T> Specifies which type of {@link AbstractDatabaseManager} this Appender requires.
*/
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.java
index 1d5f5f4942..b7a7dedd4d 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.java
@@ -89,7 +89,7 @@ public final class RewriteAppender extends AbstractAppender {
/**
* Creates a RewriteAppender.
* @param name The name of the Appender.
- * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise
+ * @param ignoreExceptions If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise
* they are propagated to the caller.
* @param appenderRefs An array of Appender names to call.
* @param config The Configuration.
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.java
index c32955f0bf..19ea9aac6a 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/DeleteAction.java
@@ -189,8 +189,8 @@ public class DeleteAction extends AbstractPathAction {
* href="http://logging.apache.org/log4j/2.x/manual/configuration.html#StatusMessages">status logger</a>
* at INFO level. Users can use this to do a dry run to test if their configuration works as expected.
* Default is false.
- * @param PathSorter a plugin implementing the {@link PathSorter} interface
- * @param PathConditions an array of path conditions (if more than one, they all need to accept a path before it is
+ * @param sorterParameter a plugin implementing the {@link PathSorter} interface
+ * @param pathConditions an array of path conditions (if more than one, they all need to accept a path before it is
* deleted).
* @param config The Configuration.
* @return A DeleteAction.
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/IfAccumulatedFileSize.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/IfAccumulatedFileSize.java
index 5c1e29e2dc..630baaa22f 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/IfAccumulatedFileSize.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/IfAccumulatedFileSize.java
@@ -92,7 +92,7 @@ public final class IfAccumulatedFileSize implements PathCondition {
/**
* Create an IfAccumulatedFileSize condition.
*
- * @param threshold The threshold accumulated file size from which files will be deleted.
+ * @param size The threshold accumulated file size from which files will be deleted.
* @return An IfAccumulatedFileSize condition.
*/
@PluginFactory
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/SortingVisitor.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/SortingVisitor.java
index d95d55a4af..819aa7bb75 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/SortingVisitor.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/SortingVisitor.java
@@ -40,10 +40,9 @@ public class SortingVisitor extends SimpleFileVisitor<Path> {
private final List<PathWithAttributes> collected = new ArrayList<>();
/**
- * Constructs a new DeletingVisitor.
+ * Constructs a new SortingVisitor.
*
- * @param basePath used to relativize paths
- * @param pathFilters objects that need to confirm whether a file can be deleted
+ * @param sorter used to sort paths
*/
public SortingVisitor(final PathSorter sorter) {
this.sorter = Objects.requireNonNull(sorter, "sorter");
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactory.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactory.java
index cdee953c57..0f71b4bb2e 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactory.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/async/AsyncQueueFullPolicyFactory.java
@@ -29,12 +29,14 @@ import org.apache.logging.log4j.util.PropertyEnvironment;
* created by this factory is used in AsyncLogger, AsyncLoggerConfig and AsyncAppender
* to control if events are logged in the current thread, the background thread, or discarded.
* <p>
- * Property {@value Log4jPropertyKey#ASYNC_LOGGER_QUEUE_FULL_POLICY} controls the routing behaviour. If this property is not specified or has
+ * Property {@link Log4jPropertyKey#ASYNC_LOGGER_QUEUE_FULL_POLICY} controls the routing behaviour. If this property is
+ * not specified or has
* value {@code "Default"}, this factory creates {@link DefaultAsyncQueueFullPolicy} objects.
* </p> <p>
* If this property has value {@code "Discard"}, this factory creates {@link DiscardingAsyncQueueFullPolicy} objects.
* By default, this router discards events of level {@code INFO}, {@code DEBUG} and {@code TRACE} if the queue is full.
- * This can be adjusted with property {@value Log4jPropertyKey#ASYNC_LOGGER_DISCARD_THRESHOLD} (name of the level at which to start
+ * This can be adjusted with property {@link Log4jPropertyKey#ASYNC_LOGGER_DISCARD_THRESHOLD} (name of the level at
+ * which to start
* discarding).
* </p> <p>
* For any other value, this
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/async/DiscardingAsyncQueueFullPolicy.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/async/DiscardingAsyncQueueFullPolicy.java
index 751803c93b..59f1df6365 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/async/DiscardingAsyncQueueFullPolicy.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/async/DiscardingAsyncQueueFullPolicy.java
@@ -26,7 +26,7 @@ import org.apache.logging.log4j.status.StatusLogger;
/**
* Discarding router extends the DefaultAsyncQueueFullPolicy by first verifying if the queue is fuller than the specified
* threshold ratio; if this is the case, log events {@linkplain Level#isMoreSpecificThan(Level) more specific} than
- * the specified threshold level are dropped. If this is not the case, the {@linkplain DefaultAsyncQueueFullPolicy
+ * the specified threshold level are dropped. If this is not the case, the {@linkplain DefaultAsyncQueueFullPolicy}
* default routing rules hold.
*/
public class DiscardingAsyncQueueFullPolicy extends DefaultAsyncQueueFullPolicy {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/Property.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/Property.java
index 0954fe63da..0ac7c9b719 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/Property.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/Property.java
@@ -66,7 +66,7 @@ public final class Property {
/**
* Returns {@code true} if the value contains a substitutable property that requires a lookup to be resolved.
- * @return {@code true} if the value contains {@code "${"}, {@code false} otherwise
+ * @return {@code true} if the value contains "${", {@code false} otherwise
*/
public boolean isValueNeedsLookup() {
return valueNeedsLookup;
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StringMatchFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StringMatchFilter.java
index a0eae725ea..4c9daacce5 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StringMatchFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/StringMatchFilter.java
@@ -29,7 +29,7 @@ import org.apache.logging.log4j.plugins.PluginFactory;
import org.apache.logging.log4j.util.PerformanceSensitive;
/**
- * This filter returns the onMatch result if the logging level in the event matches the specified logging level
+ * This filter returns the onMatch result if the message in the event matches the specified text
* exactly.
*/
@Configurable(elementType = Filter.ELEMENT_TYPE, printObject = true)
@@ -158,8 +158,8 @@ public final class StringMatchFilter extends AbstractFilter {
private String text = "";
/**
- * Sets the logging level to use.
- * @param level the logging level to use.
+ * Sets the text to match.
+ * @param text the text to match.
* @return this
*/
public StringMatchFilter.Builder setMatchString(final String text) {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ContextDataFactory.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ContextDataFactory.java
index 9adcc61ad6..f792356743 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ContextDataFactory.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ContextDataFactory.java
@@ -35,7 +35,7 @@ import org.apache.logging.log4j.util.StringMap;
* instances may be either populated with key-value pairs from the context, or completely replaced altogether.
* <p>
* By default returns {@code SortedArrayStringMap} objects. Can be configured by setting system property
- * {@value Log4jPropertyKey#THREAD_CONTEXT_DATA_CLASS_NAME}
+ * {@link Log4jPropertyKey#THREAD_CONTEXT_DATA_CLASS_NAME}
* to the fully qualified class name of a class implementing the {@code StringMap}
* interface. The class must have a public default constructor, and if possible should also have a public constructor
* that takes a single {@code int} argument for the initial capacity.
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThreadContextDataInjector.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThreadContextDataInjector.java
index 7492bdbea0..37b3d3f647 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThreadContextDataInjector.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThreadContextDataInjector.java
@@ -104,7 +104,7 @@ public class ThreadContextDataInjector {
* specified reusable StringMap.
*
* @param props list of configuration properties, may be {@code null}
- * @param contextData a {@code StringMap} instance from the log event
+ * @param ignore a {@code StringMap} instance from the log event
* @return a {@code StringMap} combining configuration properties with thread context data
*/
@Override
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/AbstractLayout.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/AbstractLayout.java
index 6376f674ee..51268573b1 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/AbstractLayout.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/AbstractLayout.java
@@ -168,9 +168,9 @@ public abstract class AbstractLayout implements Layout {
* {@code AbstractStringLayout} provides various convenience methods to help with this:
* </p>
* <pre>@Category(Node.CATEGORY)
- * @Plugin(value = "MyLayout", elementType = Layout.ELEMENT_TYPE, printObject = true)
+ * @Plugin(value = "MyLayout", elementType = Layout.ELEMENT_TYPE, printObject = true)
* public final class MyLayout extends AbstractStringLayout {
- * @Override
+ * @Override
* public void encode(LogEvent event, ByteBufferDestination destination) {
* StringBuilder text = getStringBuilder();
* convertLogEventToText(event, text);
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Facility.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Facility.java
index ff512ca9ec..e36332dce0 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Facility.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Facility.java
@@ -22,6 +22,7 @@ import org.apache.logging.log4j.util.EnglishEnums;
* The facility codes used by the Syslog system.
*
* <table>
+ * <caption>Facilities</caption>
* <tr>
* <th>Numerical Code</th>
* <th>Facility</th>
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/NamePatternConverter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/NamePatternConverter.java
index 26a8e02624..102a90e54a 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/NamePatternConverter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/NamePatternConverter.java
@@ -51,7 +51,6 @@ public abstract class NamePatternConverter extends LogEventPatternConverter {
*
* @param original string containing name.
* @param destination the StringBuilder to write to
- * @return The abbreviated name.
*/
protected final void abbreviate(final String original, final StringBuilder destination) {
abbreviator.abbreviate(original, destination);
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/ClockFactory.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/ClockFactory.java
index c1536d1f26..2d267ff054 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/ClockFactory.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/ClockFactory.java
@@ -47,7 +47,7 @@ public final class ClockFactory {
/**
* Returns a {@code Clock} instance depending on the value of system
- * property {@link #PROPERTY_NAME}.
+ * property {@link Log4jPropertyKey#CONFIG_CLOCK}.
* <p>
* If system property {@code log4j.Clock=CachedClock} is specified,
* this method returns an instance of {@link CachedClock}. If system
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/InstantFormatter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/InstantFormatter.java
index 92bfcf0905..e6539989c1 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/InstantFormatter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/InstantFormatter.java
@@ -85,7 +85,7 @@ public final class InstantFormatter {
/**
* Checks if the given {@link Instant}s are equal from the point of view of the employed formatter.
* <p>
- * This method should be preferred over {@link Instant#equals(Object)}.
+ * This method should be preferred over {@link Object#equals(Object)}.
* For instance, {@link FixedDateFormat} and {@link FastDateFormat} discard nanoseconds, hence, from their point of view, two different {@code Instant}s are equal if they match up to millisecond precision.
* </p>
*/
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java
index 42ed01290b..be3d141a57 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/tools/picocli/CommandLine.java
@@ -2799,7 +2799,7 @@ public class CommandLine {
/**
* A collection of methods and inner classes that provide fine-grained control over the contents and layout of
* the usage help message to display to end users when help is requested or invalid input values were specified.
- * <h3>Layered API</h3>
+ * <h2>Layered API</h2>
* <p>The {@link Command} annotation provides the easiest way to customize usage help messages. See
* the <a href="https://remkop.github.io/picocli/index.html#_usage_help">Manual</a> for details.</p>
* <p>This Help class provides high-level functions to create sections of the usage help message and headings
@@ -2807,7 +2807,7 @@ public class CommandLine {
* method, application authors may want to create a custom usage help message by reorganizing sections in a
* different order and/or adding custom sections.</p>
* <p>Finally, the Help class contains inner classes and interfaces that can be used to create custom help messages.</p>
- * <h4>IOptionRenderer and IParameterRenderer</h4>
+ * <h3>IOptionRenderer and IParameterRenderer</h3>
* <p>Renders a field annotated with {@link Option} or {@link Parameters} to an array of {@link Text} values.
* By default, these values are</p><ul>
* <li>mandatory marker character (if the option/parameter is {@link Option#required() required})</li>
@@ -2817,15 +2817,15 @@ public class CommandLine {
* <li>description</li>
* </ul>
* <p>Other components rely on this ordering.</p>
- * <h4>Layout</h4>
+ * <h3>Layout</h3>
* <p>Delegates to the renderers to create {@link Text} values for the annotated fields, and uses a
* {@link TextTable} to display these values in tabular format. Layout is responsible for deciding which values
* to display where in the table. By default, Layout shows one option or parameter per table row.</p>
- * <h4>TextTable</h4>
+ * <h3>TextTable</h3>
* <p>Responsible for spacing out {@link Text} values according to the {@link Column} definitions the table was
* created with. Columns have a width, indentation, and an overflow policy that decides what to do if a value is
* longer than the column's width.</p>
- * <h4>Text</h4>
+ * <h3>Text</h3>
* <p>Encapsulates rich text with styles and colors in a way that other components like {@link TextTable} are
* unaware of the embedded ANSI escape codes.</p>
*/
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Constants.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Constants.java
index 1c27ef8492..34ef31974d 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Constants.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Constants.java
@@ -86,7 +86,7 @@ public final class Constants {
/**
* Initial StringBuilder size used in RingBuffer LogEvents to store the contents of reusable Messages.
* <p>
- * The default value is {@value}, users can override with system property "log4j.initialReusableMsgSize".
+ * The default value is {@literal 128}, users can override with system property "log4j.initialReusableMsgSize".
* </p>
* @since 2.6
*/
@@ -96,7 +96,7 @@ public final class Constants {
* Maximum size of the StringBuilders used in RingBuffer LogEvents to store the contents of reusable Messages.
* After a large message has been delivered to the appenders, the StringBuilder is trimmed to this size.
* <p>
- * The default value is {@value}, which allows the StringBuilder to resize three times from its initial size.
+ * The default value is {@literal 518}, which allows the StringBuilder to resize three times from its initial size.
* Users can override with system property "log4j.maxReusableMsgSize".
* </p>
* @since 2.6
@@ -106,7 +106,7 @@ public final class Constants {
/**
* Size of CharBuffers used by text encoders.
* <p>
- * The default value is {@value}, users can override with system property "log4j.encoder.charBufferSize".
+ * The default value is {@literal 2048}, users can override with system property "log4j.encoder.charBufferSize".
* </p>
* @since 2.6
*/
@@ -115,7 +115,7 @@ public final class Constants {
/**
* Default size of ByteBuffers used to encode LogEvents without allocating temporary objects.
* <p>
- * The default value is {@value}, users can override with system property "log4j.encoder.byteBufferSize".
+ * The default value is {@literal 8192}, users can override with system property "log4j.encoder.byteBufferSize".
* </p>
* @see org.apache.logging.log4j.core.layout.ByteBufferDestination
* @since 2.6
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java
index 9802b1de28..587c74141d 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java
@@ -43,7 +43,8 @@ import static org.apache.logging.log4j.util.Strings.toRootUpperCase;
* Cron expressions are comprised of 6 required fields and one optional field
* separated by white space. The fields respectively are described as follows:
* <p/>
- * <table cellspacing="8">
+ * <table>
+ * <caption>Cron fields</caption>
* <tr>
* <th align="left">Field Name</th>
* <th align="left"> </th>
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ProcessIdUtil.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ProcessIdUtil.java
index 223355aae9..2581ab86e2 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ProcessIdUtil.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ProcessIdUtil.java
@@ -21,7 +21,7 @@ import java.io.IOException;
import java.lang.reflect.Method;
/**
- * @Since 2.9
+ * @since 2.9
*/
public class ProcessIdUtil {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java
index 523a2ddea2..2348ab3a3d 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java
@@ -27,7 +27,7 @@ import java.io.Writer;
* For safe usage with multiple {@link Thread}s then
* <code>java.io.StringWriter</code> should be used.
*
- * <h3>History</h3>
+ * <h2>History</h2>
* <ol>
* <li>Copied from Apache Commons IO revision 1681000.</li>
* <li>Pick up Javadoc updates from revision 1722253.</li>
(logging-log4j2) 01/05: Switch to official Maven Javadoc plugin properties
Posted by pk...@apache.org.
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 3389ee7482674e61243fe01addd2be901b6dff00
Author: Piotr P. Karwasz <pi...@karwasz.org>
AuthorDate: Thu Nov 2 19:28:41 2023 +0100
Switch to official Maven Javadoc plugin properties
---
log4j-api/pom.xml | 2 +-
log4j-core/pom.xml | 2 +-
log4j-parent/pom.xml | 2 +-
pom.xml | 11 ++++-------
4 files changed, 7 insertions(+), 10 deletions(-)
diff --git a/log4j-api/pom.xml b/log4j-api/pom.xml
index 8f4934a00c..4f529fbd12 100644
--- a/log4j-api/pom.xml
+++ b/log4j-api/pom.xml
@@ -32,7 +32,7 @@
<log4jParentDir>${basedir}/..</log4jParentDir>
<docLabel>API Documentation</docLabel>
<projectDir>/api</projectDir>
- <javadoc.skip>false</javadoc.skip>
+ <maven.javadoc.skip>false</maven.javadoc.skip>
<!--
~ OSGi and JPMS options
diff --git a/log4j-core/pom.xml b/log4j-core/pom.xml
index 006859b806..98dae41e27 100644
--- a/log4j-core/pom.xml
+++ b/log4j-core/pom.xml
@@ -32,7 +32,7 @@
<log4jParentDir>${basedir}/..</log4jParentDir>
<docLabel>Core Documentation</docLabel>
<projectDir>/core</projectDir>
- <javadoc.skip>false</javadoc.skip>
+ <maven.javadoc.skip>false</maven.javadoc.skip>
<!--
~ OSGi and JPMS options
diff --git a/log4j-parent/pom.xml b/log4j-parent/pom.xml
index 66b09d7dc1..e38253cb66 100644
--- a/log4j-parent/pom.xml
+++ b/log4j-parent/pom.xml
@@ -61,7 +61,7 @@
<!-- `maven-javadoc-plugin` is only used to generate Javadoc HTML used in the website.
We don't deploy any Javadoc JARs.
We also don't generate Javadoc HTML for all modules, but only for two modules: `log4j-api` and `log4j-core`. -->
- <javadoc.skip>true</javadoc.skip>
+ <maven.javadoc.skip>true</maven.javadoc.skip>
<!-- Skipping `maven-site-plugin` globally.
It is manually enabled only for the parent module below. -->
<maven.site.skip>true</maven.site.skip>
diff --git a/pom.xml b/pom.xml
index fefa94570c..d96fe7c058 100644
--- a/pom.xml
+++ b/pom.xml
@@ -334,8 +334,8 @@
<!-- `maven-javadoc-plugin` is only used to generate Javadoc HTML used in the website.
We don't deploy any Javadoc JARs.
We also don't generate Javadoc HTML for all modules, but only for two modules: `log4j-api` and `log4j-core`. -->
- <javadoc.doclint>all,-missing,-html</javadoc.doclint>
- <javadoc.skip>true</javadoc.skip>
+ <doclint>all,-missing,-html</doclint>
+ <maven.javadoc.skip>true</maven.javadoc.skip>
<!-- Skipping `maven-site-plugin` globally.
It is manually enabled only for this root module below. -->
<maven.site.skip>true</maven.site.skip>
@@ -722,12 +722,9 @@
</goals>
<phase>pre-site</phase>
<!-- This execution must be inherited and enabled by modules publishing javadocs: `-api` and `-core`.
- Such modules enable this execution via `javadoc.skip` property.
+ Such modules enable this execution via `maven.javadoc.skip` property.
Hence, don't insert a `<inherited>false</inherited>`, please! -->
- <configuration combine.self="override">
- <!-- `notimestamp` avoids `diff` noise and is required for reproducible builds: https://maven.apache.org/guides/mini/guide-reproducible-builds.html -->
- <notimestamp>true</notimestamp>
- <skip>${javadoc.skip}</skip>
+ <configuration>
<bottom><![CDATA[<p align="center">
Copyright © {inceptionYear}-{currentYear} {organizationName}.
All Rights Reserved.<br/>
(logging-log4j2) 04/05: Fix remaining Javadoc errors in `log4j-api`
Posted by pk...@apache.org.
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 <pi...@karwasz.org>
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
(logging-log4j2) 02/05: Remove invalid javadoc links
Posted by pk...@apache.org.
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 9f45b062b3868b13a96edef4b1bb93fb7c1f543c
Author: Lukasz Spyra <lu...@gmail.com>
AuthorDate: Fri Oct 6 14:28:40 2023 +0200
Remove invalid javadoc links
Links were removed due to following reasons: dependency commons-lang3 not containing docs sources; package sun.reflect.Reflection was deprecated and removed in JDK8
---
.../java/org/apache/logging/log4j/core/impl/ExtendedClassInfo.java | 6 +++---
.../apache/logging/log4j/core/impl/ExtendedStackTraceElement.java | 2 +-
.../logging/log4j/core/time/internal/format/FastDateParser.java | 3 ++-
3 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ExtendedClassInfo.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ExtendedClassInfo.java
index 63ad5b2956..32b35d3cd5 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ExtendedClassInfo.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ExtendedClassInfo.java
@@ -33,9 +33,9 @@ public final class ExtendedClassInfo {
/**
* Constructs a new instance.
*
- * @param exact
- * @param location
- * @param version
+ * @param exact Whether the class was obtained via {@code sun.reflect.Reflection#getCallerClass(int)}.
+ * @param location a classpath element or a jar
+ * @param version the string describing a version
*/
public ExtendedClassInfo(final boolean exact, final String location, final String version) {
super();
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ExtendedStackTraceElement.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ExtendedStackTraceElement.java
index 04b91e3bc3..34fbc6473f 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ExtendedStackTraceElement.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ExtendedStackTraceElement.java
@@ -26,7 +26,7 @@ import org.apache.logging.log4j.util.Strings;
* Complements a StackTraceElement with:
* </p>
* <ul>
- * <li>exact: whether the class was obtained via {@link sun.reflect.Reflection#getCallerClass(int)}</li>
+ * <li>exact: whether the class was obtained via {@code sun.reflect.Reflection#getCallerClass(int)}</li>
* <li>location: a classpath element or a jar</li>
* <li>version</li>
* </ul>
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/format/FastDateParser.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/format/FastDateParser.java
index 9f7296690e..4b175153f7 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/format/FastDateParser.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/time/internal/format/FastDateParser.java
@@ -368,7 +368,8 @@ public class FastDateParser implements DateParser {
* given by {@link ParsePosition#getIndex()} has been updated. If the input buffer has been fully
* parsed, then the index will point to just after the end of the input buffer.
*
- * @see org.apache.commons.lang3.time.DateParser#parse(java.lang.String, java.text.ParsePosition)
+ * @see <a href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/time/DateParser.html#parse-java.lang.String-java.text.ParsePosition-">
+ * org.apache.commons.lang3.time.DateParser#parse(String, ParsePosition)</a>
*/
@Override
public Date parse(final String source, final ParsePosition pos) {