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 <[email protected]> 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>
