This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x by this push:
new 5cc765d77d Fix cut-and-paste errors in Javadoc (#1467)
5cc765d77d is described below
commit 5cc765d77daa68260dbbf79b6b2c0799d32f12bc
Author: Michael Ernst <[email protected]>
AuthorDate: Mon May 15 13:14:15 2023 -0700
Fix cut-and-paste errors in Javadoc (#1467)
---
.../org/apache/logging/log4j/core/layout/JsonLayout.java | 2 +-
.../org/apache/logging/log4j/core/layout/YamlLayout.java | 2 +-
.../apache/logging/log4j/core/lookup/StrSubstitutor.java | 14 +++++++-------
.../java/org/apache/logging/log4j/core/net/Facility.java | 4 ++--
4 files changed, 11 insertions(+), 11 deletions(-)
diff --git
a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java
b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java
index b2e1ecb423..cae7ee11eb 100644
---
a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java
+++
b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java
@@ -242,7 +242,7 @@ public final class JsonLayout extends AbstractJacksonLayout
{
* @param headerPattern
* The header pattern, defaults to {@code "["} if null.
* @param footerPattern
- * The header pattern, defaults to {@code "]"} if null.
+ * The footer pattern, defaults to {@code "]"} if null.
* @param charset
* The character set to use, if {@code null}, uses "UTF-8".
* @param includeStacktrace
diff --git
a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java
b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java
index 6507d06f7c..e62fd2f7cb 100644
---
a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java
+++
b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java
@@ -167,7 +167,7 @@ public final class YamlLayout extends AbstractJacksonLayout
{
* @param headerPattern
* The header pattern, defaults to {@code ""} if null.
* @param footerPattern
- * The header pattern, defaults to {@code ""} if null.
+ * The footer pattern, defaults to {@code ""} if null.
* @param charset
* The character set to use, if {@code null}, uses "UTF-8".
* @param includeStacktrace
diff --git
a/log4j-core/src/main/java/org/apache/logging/log4j/core/lookup/StrSubstitutor.java
b/log4j-core/src/main/java/org/apache/logging/log4j/core/lookup/StrSubstitutor.java
index fee7a39ec5..41769c447a 100644
---
a/log4j-core/src/main/java/org/apache/logging/log4j/core/lookup/StrSubstitutor.java
+++
b/log4j-core/src/main/java/org/apache/logging/log4j/core/lookup/StrSubstitutor.java
@@ -827,7 +827,7 @@ public class StrSubstitutor implements ConfigurationAware {
* with their matching values from the resolver.
* The buffer is updated with the result.
*
- * @param source the buffer to replace in, updated, null returns zero
+ * @param source the buffer to replace in, updated, null returns false
* @return true if altered
*/
public boolean replaceIn(final StringBuffer source) {
@@ -846,7 +846,7 @@ public class StrSubstitutor implements ConfigurationAware {
* The rest of the buffer is not processed, but it is not deleted.
* </p>
*
- * @param source the buffer to replace in, updated, null returns zero
+ * @param source the buffer to replace in, updated, null returns false
* @param offset the start offset within the array, must be valid
* @param length the length within the buffer to be processed, must be
valid
* @return true if altered
@@ -865,7 +865,7 @@ public class StrSubstitutor implements ConfigurationAware {
* </p>
*
* @param event the current LogEvent, if one exists.
- * @param source the buffer to replace in, updated, null returns zero
+ * @param source the buffer to replace in, updated, null returns false
* @param offset the start offset within the array, must be valid
* @param length the length within the buffer to be processed, must be
valid
* @return true if altered
@@ -892,7 +892,7 @@ public class StrSubstitutor implements ConfigurationAware {
* Replaces all the occurrences of variables within the given source
* builder with their matching values from the resolver.
*
- * @param source the builder to replace in, updated, null returns zero
+ * @param source the builder to replace in, updated, null returns false
* @return true if altered
*/
public boolean replaceIn(final StringBuilder source) {
@@ -905,7 +905,7 @@ public class StrSubstitutor implements ConfigurationAware {
* builder with their matching values from the resolver.
*
* @param event the current LogEvent, if one exists.
- * @param source the builder to replace in, updated, null returns zero
+ * @param source the builder to replace in, updated, null returns false
* @return true if altered
*/
public boolean replaceIn(final LogEvent event, final StringBuilder source)
{
@@ -922,7 +922,7 @@ public class StrSubstitutor implements ConfigurationAware {
* The rest of the builder is not processed, but it is not deleted.
* </p>
*
- * @param source the builder to replace in, null returns zero
+ * @param source the builder to replace in, null returns false
* @param offset the start offset within the array, must be valid
* @param length the length within the builder to be processed, must be
valid
* @return true if altered
@@ -940,7 +940,7 @@ public class StrSubstitutor implements ConfigurationAware {
* </p>
*
* @param event the current LogEvent, if one is present.
- * @param source the builder to replace in, null returns zero
+ * @param source the builder to replace in, null returns false
* @param offset the start offset within the array, must be valid
* @param length the length within the builder to be processed, must be
valid
* @return true if altered
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..1569ab76a7 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
@@ -207,7 +207,7 @@ public enum Facility {
/**
* Returns the Facility for the given string.
*
- * @param name The Facility enum name, case-insensitive. If null, returns,
null
+ * @param name The Facility enum name, case-insensitive. If null, returns
null
* @return a Facility enum value or null if name is null
*/
public static Facility toFacility(final String name) {
@@ -219,7 +219,7 @@ public enum Facility {
*
* @param name The Facility enum name, case-insensitive. If null, returns,
defaultFacility
* @param defaultFacility the Facility to return if name is null
- * @return a Facility enum value or null if name is null
+ * @return a Facility enum value or defaultFacility if name is null
*/
public static Facility toFacility(final String name, final Facility
defaultFacility) {
return EnglishEnums.valueOf(Facility.class, name, defaultFacility);
