Merge 'lukaszspyra/issue-1275-broken-javadoc' (#1275, #1753)
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/BridgeAware.java b/log4j-api/src/main/java/org/apache/logging/log4j/BridgeAware.java
index c79bf42..4ee476c 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/BridgeAware.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/BridgeAware.java
@@ -24,10 +24,10 @@
public interface BridgeAware {
/**
- * Fully qualified class name of the entry point to the logging system. This
+ * To set fully qualified class name of the entry point to the logging system. This
* class will not appear in the location information.
*
- * @param fqcn
+ * @param fqcn fully qualified class name
*/
void setEntryPoint(final String fqcn);
}
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 2ca0496..0fd2446 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,7 +28,9 @@
/**
* Levels used for identifying the severity of an event. Levels are organized from most specific to least:
+ * <p>
* <table>
+ * <caption>Level names with description</caption>
* <tr>
* <th>Name</th>
* <th>Description</th>
@@ -66,6 +68,7 @@
* <td>All events should be logged.</td>
* </tr>
* </table>
+ * </p>
* <p>
* Typically, configuring a level in a filter or on a logger will cause logging events of that level and those that are
* more specific to pass through the filter. A special level, {@link #ALL}, is guaranteed to capture all levels when
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/AbstractMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/AbstractMessageFactory.java
index 17830e2..0a394e4 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/message/AbstractMessageFactory.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/AbstractMessageFactory.java
@@ -24,7 +24,9 @@
* <p>
* This class is immutable.
* </p>
- * <h4>Note to implementors</h4>
+ * <p>
+ * <strong>Note to implementors:</strong>
+ * </p>
* <p>
* Subclasses can implement the {@link MessageFactory2} methods when they can most effectively build {@link Message}
* instances. If a subclass does not implement {@link MessageFactory2} methods, these calls are routed through
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 59a5113..6ddc606 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
@@ -20,7 +20,9 @@
* Creates {@link FormattedMessage} instances for {@link MessageFactory2} methods (and {@link MessageFactory} by
* extension.)
*
- * <h4>Note to implementors</h4>
+ * <p>
+ * <strong>Note to implementors:</strong>
+ * </p>
* <p>
* This class implements all {@link MessageFactory2} 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 c08f337..9500bf5 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
@@ -22,7 +22,9 @@
* Creates {@link FormattedMessage} instances for {@link MessageFactory2} methods (and {@link MessageFactory} by
* extension.)
*
- * <h4>Note to implementors</h4>
+ * <p>
+ * <strong>Note to implementors:</strong>
+ * </p>
* <p>
* This class does <em>not</em> implement any {@link MessageFactory2} 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 d07b9bf..d4e8e51 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 @@
/**
* Creates {@link FormattedMessage} instances for {@link MessageFactory2} methods (and {@link MessageFactory} by
* extension.)
- *
- * <h4>Note to implementors</h4>
+ * <p>
+ * <strong>Note to implementors:</strong>
+ * </p>
* <p>
* This class implements all {@link MessageFactory2} methods.
* </p>
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterConsumer.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterConsumer.java
index 7297077..960dedb 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterConsumer.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterConsumer.java
@@ -35,7 +35,7 @@
*
* @param parameter the parameter
* @param parameterIndex Index of the parameter
- * @param state
+ * @param state the state data
*/
void accept(Object parameter, int parameterIndex, S state);
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 d57e575..d6c7bc7 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
@@ -29,7 +29,9 @@
* This class is immutable.
* </p>
*
- * <h4>Note to implementors</h4>
+ * <p>
+ * <strong>Note to implementors:</strong>
+ * </p>
* <p>
* This class implements all {@link MessageFactory2} 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 f1e6cd1..19a99bf 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
@@ -31,7 +31,9 @@
* <p>
* This class is immutable.
* </p>
- * <h4>Note to implementors</h4>
+ * <p>
+ * <strong>Note to implementors:</strong>
+ * </p>
* <p>
* This class does <em>not</em> implement any {@link MessageFactory2} 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 28206f0..e1843a4 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 @@
* <p>
* This class is immutable.
* </p>
- *
- * <h4>Note to implementors</h4>
+ * <p>
+ * <strong>Note to implementors:</strong>
+ * </p>
* <p>
* This class implements all {@link MessageFactory2} 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 0ab35a5..c675334 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
@@ -29,7 +29,9 @@
/**
* Handles messages that consist of a format string conforming to {@link java.util.Formatter}.
*
- * <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 d112aa7..c2a9532 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
@@ -28,7 +28,9 @@
* <p>
* This class is immutable.
* </p>
- * <h4>Note to implementors</h4>
+ * <p>
+ * <strong>Note to implementors:</strong>
+ * </p>
* <p>
* This class implements all {@link MessageFactory2} methods.
* </p>
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 0710cb3..e0ba99a 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
@@ -79,9 +79,9 @@
/**
*
- * @param name
- * @param required
- * @param optional
+ * @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.
*/
public StructuredDataId(final String name, final String[] required, final String[] optional) {
this(name, required, optional, MAX_LENGTH);
@@ -93,6 +93,7 @@
* @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's name.
* @since 2.9
*/
public StructuredDataId(final String name, final String[] required, final String[] optional, int maxLength) {
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/MutableThreadContextStack.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/MutableThreadContextStack.java
index 34ff9e6..9334551 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/MutableThreadContextStack.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/MutableThreadContextStack.java
@@ -47,7 +47,7 @@
/**
* Constructs a new instance.
- * @param list
+ * @param list Initial elements to be stored in this stack implementation.
*/
public MutableThreadContextStack(final List<String> list) {
this.list = new ArrayList<>(list);
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/EnglishEnums.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/EnglishEnums.java
index 70103ce..93f125f 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/util/EnglishEnums.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/EnglishEnums.java
@@ -26,7 +26,7 @@
* Helps convert English Strings to English Enum values.
* </p>
* <p>
- * Enum name arguments are converted internally to upper case with the {@linkplain Locale#ENGLISH ENGLISH} locale to
+ * Enum name arguments are converted internally to upper case with the {@linkplain java.util.Locale#ENGLISH ENGLISH} locale to
* avoid problems on the Turkish locale. Do not use with Turkish enum values.
* </p>
*/
@@ -38,7 +38,7 @@
/**
* Returns the Result for the given string.
* <p>
- * The {@code name} is converted internally to upper case with the {@linkplain Locale#ENGLISH ENGLISH} locale to
+ * The {@code name} is converted internally to upper case with the {@linkplain java.util.Locale#ENGLISH ENGLISH} locale to
* avoid problems on the Turkish locale. Do not use with Turkish enum values.
* </p>
*
@@ -54,7 +54,7 @@
/**
* Returns an enum value for the given string.
* <p>
- * The {@code name} is converted internally to upper case with the {@linkplain Locale#ENGLISH ENGLISH} locale to
+ * The {@code name} is converted internally to upper case with the {@linkplain java.util.Locale#ENGLISH ENGLISH} locale to
* avoid problems on the Turkish locale. Do not use with Turkish enum values.
* </p>
*
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/ProcessIdUtil.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/ProcessIdUtil.java
index 23963de..af0ed04 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/util/ProcessIdUtil.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/ProcessIdUtil.java
@@ -21,7 +21,7 @@
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/appender/AbstractOutputStreamAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/AbstractOutputStreamAppender.java
index 4417af0..06f795c 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
@@ -129,6 +129,10 @@
*
* @param name The name of the Appender.
* @param layout The layout to format the message.
+ * @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.
*/
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 02cf247..9da021f 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,6 +54,13 @@
* The name of the Appender.
* @param layout
* The layout to format the message.
+ * @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
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/jdbc/JdbcDatabaseManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/jdbc/JdbcDatabaseManager.java
index f68f54c..2850b62 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/jdbc/JdbcDatabaseManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/jdbc/JdbcDatabaseManager.java
@@ -421,13 +421,14 @@
*
* @param name The name of the manager, which should include connection details and hashed passwords where possible.
* @param bufferSize The size of the log event buffer.
- * @param layout
+ * @param layout the Appender-level layout
* @param connectionSource The source for connections to the database.
* @param tableName The name of the database table to insert log events into.
* @param columnConfigs Configuration information about the log table columns.
* @param columnMappings column mapping configuration (including type conversion).
- * @param reconnectIntervalMillis
- * @param immediateFail
+ * @param reconnectIntervalMillis How often to reconnect to the database when a SQL exception is detected.
+ * @param immediateFail Whether to fail immediately with a {@link AppenderLoggingException} when connecting
+ * to JDBC fails.
* @return a new or existing JDBC manager as applicable.
* @deprecated use
* {@link #getManager(String, int, Layout, ConnectionSource, String, ColumnConfig[], ColumnMapping[], boolean, long)}
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 bc4f83f..c2870cb 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 @@
* 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/ScriptCondition.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/ScriptCondition.java
index 0995e6d..0949d48 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/ScriptCondition.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/ScriptCondition.java
@@ -36,7 +36,7 @@
/**
* A condition of the {@link DeleteAction} where a user-provided script selects the files to delete from a provided
- * list. The specified script may be a {@link Script}, a {@link ScriptFile} or a {@link ScriptRef}.
+ * list. The specified script may be a {@link org.apache.logging.log4j.core.script.Script}, a {@link ScriptFile} or a {@link ScriptRef}.
*
* @see #createCondition(AbstractScript, Configuration)
*/
@@ -61,9 +61,9 @@
/**
* Executes the script
*
- * @param baseDir
- * @param candidates
- * @return
+ * @param basePath base directory for files to delete
+ * @param candidates a list of paths, that can be deleted by the script
+ * @return a list of paths selected to delete by the script execution
*/
@SuppressWarnings("unchecked")
public List<PathWithAttributes> selectFilesToDelete(final Path basePath, final List<PathWithAttributes> candidates) {
@@ -81,15 +81,15 @@
/**
* Creates the ScriptCondition.
*
- * @param script The script to run. This may be a {@link Script}, a {@link ScriptFile} or a {@link ScriptRef}. The
+ * @param script The script to run. This may be a {@link org.apache.logging.log4j.core.script.Script}, a {@link ScriptFile} or a {@link ScriptRef}. The
* script must return a {@code List<PathWithAttributes>}. When the script is executed, it is provided the
* following bindings:
* <ul>
* <li>basePath - the directory from where the {@link DeleteAction Delete} action started scanning for
* files to delete. Can be used to relativize the paths in the pathList.</li>
- * <li>pathList - a {@code java.util.List} containing {@link PathWithAttribute} objects. (The script is
+ * <li>pathList - a {@code java.util.List} containing {@link org.apache.logging.log4j.core.appender.rolling.action.PathWithAttributes} objects. (The script is
* free to modify and return this list.)</li>
- * <li>substitutor - a {@link StrSubstitutor} that can be used to look up variables embedded in the base
+ * <li>substitutor - a {@link org.apache.logging.log4j.core.lookup.StrSubstitutor} that can be used to look up variables embedded in the base
* dir or other properties
* <li>statusLogger - the {@link StatusLogger} that can be used to log events during script execution
* <li>any properties declared in the configuration</li>
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 d95d55a..da549ab 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 @@
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 Interface implementation which can 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/appender/routing/PurgePolicy.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/routing/PurgePolicy.java
index 904d8b0..980c669 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/routing/PurgePolicy.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/routing/PurgePolicy.java
@@ -31,14 +31,14 @@
/**
* @param key routed appender key
- * @param event
+ * @param event Provides contextual information about a logged message.
*/
void update(String key, LogEvent event);
/**
* Initializes with routing appender
*
- * @param routingAppender
+ * @param routingAppender the routed appender for purging
*/
void initialize(RoutingAppender routingAppender);
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 751803c..ce96e12 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
@@ -27,7 +27,7 @@
* 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
- * default routing rules hold.
+ * default routing} rules hold.
*/
public class DiscardingAsyncQueueFullPolicy extends DefaultAsyncQueueFullPolicy {
private static final Logger LOGGER = StatusLogger.getLogger();
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultAdvertiser.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultAdvertiser.java
index ace7c6d..2fe4f29 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultAdvertiser.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultAdvertiser.java
@@ -39,7 +39,7 @@
/**
* Does nothing.
- * @param advertisedObject
+ * @param advertisedObject the advertised object
*/
@Override
public void unadvertise(final Object advertisedObject) {
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 4ccf371..3ab42b9 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
@@ -79,7 +79,7 @@
/**
* 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 "${}"}, {@code false} otherwise
*/
public boolean isValueNeedsLookup() {
return valueNeedsLookup;
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/convert/Base64Converter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/convert/Base64Converter.java
index 2929a64..3d99098 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/convert/Base64Converter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/convert/Base64Converter.java
@@ -25,7 +25,7 @@
import org.apache.logging.log4j.util.LoaderUtil;
/**
- * @Since 2.9
+ * @since 2.9
*/
public class Base64Converter {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/convert/HexConverter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/convert/HexConverter.java
index 1d0f6bf..0111e8e 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/convert/HexConverter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/convert/HexConverter.java
@@ -20,7 +20,7 @@
* Converts Strings to hex. This is used in place of java.xml.bind.DataTypeConverter which is not available by
* default in Java 9.
*
- * @Since 2.9
+ * @since 2.9
*/
public class HexConverter {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java
index bd51688..4fd62f2 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/RegexFilter.java
@@ -119,8 +119,8 @@
* @param mismatch
* The action to perform when a mismatch occurs.
* @return The RegexFilter.
- * @throws IllegalAccessException
- * @throws IllegalArgumentException
+ * @throws IllegalAccessException When there is no access to the definition of the specified member.
+ * @throws IllegalArgumentException When passed an illegal or inappropriate argument.
*/
// TODO Consider refactoring to use AbstractFilter.AbstractFilterBuilder
@PluginFactory
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 3697ecd..4d3847d 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
@@ -158,7 +158,7 @@
/**
* Sets the logging level to use.
- * @param level the logging level to use.
+ * @param text the logging level to use
* @return this
*/
public StringMatchFilter.Builder setMatchString(final String text) {
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 e66c7c0..c7cc09e 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
@@ -38,9 +38,9 @@
/**
* 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) {
this.exact = exact;
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 11b5a51..f08226d 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
@@ -28,7 +28,7 @@
* 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/impl/ThrowableFormatOptions.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThrowableFormatOptions.java
index 379069f..1e6b17c 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThrowableFormatOptions.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThrowableFormatOptions.java
@@ -89,14 +89,14 @@
* Constructs the options for printing stack trace.
*
* @param lines
- * The number of lines.
+ * the number of lines
* @param separator
- * The stack trace separator.
+ * the stack trace separator
* @param ignorePackages
- * The packages to filter.
+ * the packages to filter
* @param textRenderer
- * The ANSI renderer
- * @param suffix
+ * the ANSI renderer
+ * @param suffix Append this to the end of each stack frame.
*/
protected ThrowableFormatOptions(final int lines, final String separator, final List<String> ignorePackages,
final TextRenderer textRenderer, final String suffix) {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThrowableProxy.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThrowableProxy.java
index ac9fd45..d088de4 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThrowableProxy.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/ThrowableProxy.java
@@ -178,7 +178,7 @@
* Formats the specified Throwable.
* @param sb StringBuilder to contain the formatted Throwable.
* @param cause The Throwable to format.
- * @param suffix
+ * @param suffix Append this to the end of each stack frame.
*/
public void formatWrapper(final StringBuilder sb, final ThrowableProxy cause, final String suffix) {
this.formatWrapper(sb, cause, null, PlainTextRenderer.getInstance(), suffix);
@@ -189,7 +189,7 @@
* @param sb StringBuilder to contain the formatted Throwable.
* @param cause The Throwable to format.
* @param ignorePackages The List of packages to be suppressed from the trace.
- * @param suffix
+ * @param suffix Append this to the end of each stack frame.
*/
@SuppressWarnings("ThrowableResultOfMethodCallIgnored")
public void formatWrapper(final StringBuilder sb, final ThrowableProxy cause, final List<String> ignorePackages, final String suffix) {
@@ -233,7 +233,7 @@
* Formats the Throwable that is the cause of this Throwable.
*
* @return The formatted Throwable that caused this Throwable.
- * @param suffix
+ * @param suffix Append this to the end of each stack frame.
*/
public String getCauseStackTraceAsString(final String suffix) {
return this.getCauseStackTraceAsString(null, PlainTextRenderer.getInstance(), suffix, EOL_STR);
@@ -411,7 +411,7 @@
* Formats the suppressed Throwables.
*
* @return The formatted suppressed Throwables.
- * @param suffix
+ * @param suffix Append this to the end of each stack frame.
*/
public String getSuppressedStackTrace(final String suffix) {
final ThrowableProxy[] suppressed = this.getSuppressedProxies();
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 59be322..bd1ee60 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
@@ -184,9 +184,9 @@
* Subclasses can override this method to provide a garbage-free implementation. For text-based layouts,
* {@code AbstractStringLayout} provides various convenience methods to help with this:
* </p>
- * <pre>@Plugin(name = "MyLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)
+ * <pre> @Plugin(name = "MyLayout", category = Node.CATEGORY, 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/layout/LevelPatternSelector.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/LevelPatternSelector.java
index 3155f1d..48e04be 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/LevelPatternSelector.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/LevelPatternSelector.java
@@ -196,11 +196,11 @@
/**
* Deprecated, use {@link #newBuilder()} instead.
- * @param properties
- * @param defaultPattern
- * @param alwaysWriteExceptions
- * @param noConsoleNoAnsi
- * @param configuration
+ * @param properties PatternMatch configuration items
+ * @param defaultPattern the default pattern
+ * @param alwaysWriteExceptions To always write exceptions even if the pattern contains no exception conversions.
+ * @param noConsoleNoAnsi Do not output ANSI escape codes if System.console() is null.
+ * @param configuration the current configuration
* @return a new MarkerPatternSelector.
* @deprecated Use {@link #newBuilder()} instead.
*/
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/MarkerPatternSelector.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/MarkerPatternSelector.java
index 70e71b2..ac4f94f 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/MarkerPatternSelector.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/MarkerPatternSelector.java
@@ -196,11 +196,11 @@
/**
* Deprecated, use {@link #newBuilder()} instead.
- * @param properties
- * @param defaultPattern
- * @param alwaysWriteExceptions
- * @param noConsoleNoAnsi
- * @param configuration
+ * @param properties PatternMatch configuration items
+ * @param defaultPattern the default pattern
+ * @param alwaysWriteExceptions To always write exceptions even if the pattern contains no exception conversions.
+ * @param noConsoleNoAnsi Do not output ANSI escape codes if System.console() is null.
+ * @param configuration the current configuration
* @return a new MarkerPatternSelector.
* @deprecated Use {@link #newBuilder()} instead.
*/
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java
index caa7a81..8f987a3 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java
@@ -152,14 +152,14 @@
/**
* Deprecated, use {@link #newSerializerBuilder()} instead.
*
- * @param configuration
- * @param replace
- * @param pattern
- * @param defaultPattern
- * @param patternSelector
- * @param alwaysWriteExceptions
- * @param noConsoleNoAnsi
- * @return a new Serializer.
+ * @param configuration the current configuration
+ * @param replace Allows portions of the resulting String to be replaced.
+ * @param pattern the current pattern
+ * @param defaultPattern the default pattern
+ * @param patternSelector Allows different patterns to be used with the PatternLayout based on some selection criteria.
+ * @param alwaysWriteExceptions To always write exceptions even if the pattern contains no exception conversions.
+ * @param noConsoleNoAnsi Do not output ANSI escape codes if System.console() is null.
+ * @return a new Serializer
* @deprecated Use {@link #newSerializerBuilder()} instead.
*/
@Deprecated
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/ScriptPatternSelector.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/ScriptPatternSelector.java
index 785800d..a37b988 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/ScriptPatternSelector.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/ScriptPatternSelector.java
@@ -264,12 +264,12 @@
/**
* Deprecated, use {@link #newBuilder()} instead.
*
- * @param script
- * @param properties
- * @param defaultPattern
- * @param alwaysWriteExceptions
- * @param noConsoleNoAnsi
- * @param configuration
+ * @param script the script
+ * @param properties the PatternMatch configuration items
+ * @param defaultPattern the default pattern
+ * @param alwaysWriteExceptions To always write exceptions even if the pattern contains no exception conversions.
+ * @param noConsoleNoAnsi Do not output ANSI escape codes if System.console() is null.
+ * @param configuration the configuration
* @return a new ScriptPatternSelector
* @deprecated Use {@link #newBuilder()} instead.
*/
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java
index 0115e07..892f64c 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java
@@ -36,13 +36,13 @@
/**
* The Constructor.
- * @param name The unique name of the connection.
- * @param os The OutputStream.
- * @param inetAddress
- * @param host The host to connect to.
- * @param port The port on the host.
- * @param layout The layout
- * @param bufferSize The buffer size
+ * @param name the unique name of the connection
+ * @param os the OutputStream
+ * @param inetAddress the Internet Protocol (IP) address
+ * @param host the host to connect to
+ * @param port the port on the host
+ * @param layout the layout
+ * @param bufferSize the buffer size
*/
protected DatagramSocketManager(final String name, final OutputStream os, final InetAddress inetAddress, final String host,
final int port, final Layout<? extends Serializable> layout, final int bufferSize) {
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 1569ab7..67a1a23 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
@@ -20,8 +20,9 @@
/**
* The facility codes used by the Syslog system.
- *
+ * <p>
* <table>
+ * <caption>Facility and corresponding numerical codes</caption>
* <tr>
* <th>Numerical Code</th>
* <th>Facility</th>
@@ -123,6 +124,7 @@
* <td>local use 7 (local7)</td>
* </tr>
* </table>
+ * </p>
*/
public enum Facility {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/MulticastDnsAdvertiser.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/MulticastDnsAdvertiser.java
index 33ca1ba..3115e61 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/MulticastDnsAdvertiser.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/MulticastDnsAdvertiser.java
@@ -117,7 +117,7 @@
/**
* Unadvertise the previously advertised entity.
*
- * @param serviceInfo
+ * @param serviceInfo instance of {@code javax.jmdns.ServiceInfo}
*/
@Override
public void unadvertise(final Object serviceInfo) {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java
index 09a7cb0..690857b 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java
@@ -42,16 +42,16 @@
/**
*
*
- * @param name The unique name of this connection.
- * @param os The OutputStream.
- * @param sock The Socket.
- * @param inetAddress The Internet address of the host.
- * @param host The name of the host.
- * @param port The port number on the host.
- * @param connectTimeoutMillis the connect timeout in milliseconds.
+ * @param name the unique name of this connection
+ * @param os the OutputStream
+ * @param sock the Socket
+ * @param inetAddress the Internet address of the host
+ * @param host the name of the host
+ * @param port the port number on the host
+ * @param connectTimeoutMillis the connect timeout in milliseconds
* @param reconnectionDelayMillis Reconnection interval.
- * @param immediateFail
- * @param layout The Layout.
+ * @param immediateFail True if the write should fail if no socket is immediately available.
+ * @param layout the Layout
* @param bufferSize The buffer size.
* @deprecated Use {@link #SslSocketManager(String, OutputStream, Socket, SslConfiguration, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions)}.
*/
@@ -75,7 +75,7 @@
* @param port The port number on the host.
* @param connectTimeoutMillis the connect timeout in milliseconds.
* @param reconnectionDelayMillis Reconnection interval.
- * @param immediateFail
+ * @param immediateFail True if the write should fail if no socket is immediately available.
* @param layout The Layout.
* @param bufferSize The buffer size.
*/
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 26a8e02..102a90e 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 @@
*
* @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/pattern/RootThrowablePatternConverter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/RootThrowablePatternConverter.java
index 2342fc6..f5d8335 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/RootThrowablePatternConverter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/RootThrowablePatternConverter.java
@@ -37,8 +37,8 @@
/**
* Private constructor.
*
- * @param config
- * @param options options, may be null.
+ * @param config the Configuration or {@code null}
+ * @param options Options, may be null.
*/
private RootThrowablePatternConverter(final Configuration config, final String[] options) {
super("RootThrowable", "throwable", options, config);
@@ -47,7 +47,7 @@
/**
* Gets an instance of the class.
*
- * @param config
+ * @param config The Configuration or {@code null}.
* @param options pattern options, may be null. If first element is "short",
* only the first line of the throwable will be formatted.
* @return instance of class.
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/ThrowablePatternConverter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/ThrowablePatternConverter.java
index 6b33e10..18347c7 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/ThrowablePatternConverter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/ThrowablePatternConverter.java
@@ -67,10 +67,10 @@
/**
* Constructor.
- * @param name Name of converter.
- * @param style CSS style for output.
+ * @param name name of converter
+ * @param style CSS style for output
* @param options options, may be null.
- * @param config
+ * @param config the Configuration or {@code null}
*/
protected ThrowablePatternConverter(final String name, final String style, final String[] options, final Configuration config) {
super(name, style);
@@ -114,7 +114,7 @@
/**
* Gets an instance of the class.
*
- * @param config
+ * @param config The Configuration or {@code null}.
* @param options pattern options, may be null. If first element is "short",
* only the first line of the throwable will be formatted.
* @return instance of class.
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 41833ee..7dc8758 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
@@ -108,7 +108,7 @@
/**
* 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 128, users can override with system property "log4j.initialReusableMsgSize".
* </p>
* @since 2.6
*/
@@ -118,7 +118,7 @@
* 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 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
@@ -128,7 +128,7 @@
/**
* 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 2048, users can override with system property "log4j.encoder.charBufferSize".
* </p>
* @since 2.6
*/
@@ -137,7 +137,7 @@
/**
* 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 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 d48993f..029aee6 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
@@ -44,6 +44,7 @@
* separated by white space. The fields respectively are described as follows:
* <p/>
* <table cellspacing="8">
+ * <caption>Cron Expressions Allowed Fields and Values</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/FileUtils.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/FileUtils.java
index c2b484d..3c634f0 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/FileUtils.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/FileUtils.java
@@ -132,8 +132,8 @@
/**
* Creates the parent directories for the given File.
*
- * @param file
- * @throws IOException
+ * @param file For which parent directory is to be created.
+ * @throws IOException Thrown if the directory could not be created.
*/
public static void makeParentDirs(final File file) throws IOException {
final File parent = Objects.requireNonNull(file, "file").getCanonicalFile().getParentFile();
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Loader.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Loader.java
index 6f9d008..21f761a 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Loader.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Loader.java
@@ -362,7 +362,7 @@
}
/**
- * Loads a class by name. This method respects the {@link #IGNORE_TCCL_PROPERTY} Log4j property. If this property is
+ * Loads a class by name. This method respects the {@link LoaderUtil#IGNORE_TCCL_PROPERTY IGNORE_TCCL_PROPERTY} Log4j property. If this property is
* specified and set to anything besides {@code false}, then the default ClassLoader will be used.
*
* @param className The class name.
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ReflectionUtil.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ReflectionUtil.java
index e019cbd..f7d7028 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ReflectionUtil.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ReflectionUtil.java
@@ -179,7 +179,7 @@
* @throws IllegalArgumentException if the given class is abstract, an interface, an array class, a primitive type,
* or void
* @throws IllegalStateException if access is denied to the constructor, or there are no default constructors
- * @throws InternalException wrapper of the underlying exception if checked
+ * @throws InternalError wrapper of the underlying exception if checked
*/
public static <T> T instantiate(final Class<T> clazz) {
Objects.requireNonNull(clazz, "No class provided");
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/datetime/FastDateParser.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/datetime/FastDateParser.java
index 5279a8d..0b7f4b4 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/datetime/FastDateParser.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/datetime/FastDateParser.java
@@ -392,7 +392,8 @@
* 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) {
diff --git a/pom.xml b/pom.xml
index cd947bb..710361a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -326,6 +326,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.doclint>all,-missing,-html</javadoc.doclint>
<javadoc.skip>true</javadoc.skip>
<!-- Skipping `maven-site-plugin` globally.
It is manually enabled only for this root module below. -->
@@ -966,7 +967,7 @@
<jdk>[1.8,)</jdk>
</activation>
<properties>
- <javadoc.opts>-Xdoclint:none</javadoc.opts>
+ <doclint>${javadoc.doclint}</doclint>
</properties>
</profile>
