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