[logging-log4j2] branch 2.x updated: Fix `PatternLayout.Builder#withHeader()` javadoc (#1411)

[vy]

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 37bf9f6d06 Fix `PatternLayout.Builder#withHeader()` javadoc (#1411)
37bf9f6d06 is described below

commit 37bf9f6d0616219d4f0572e2ea93b8d167182783
Author: Michael Ernst <mer...@cs.washington.edu>
AuthorDate: Mon Apr 10 10:50:05 2023 -0700

    Fix `PatternLayout.Builder#withHeader()` javadoc (#1411)
---
 .../main/java/org/apache/logging/log4j/core/layout/PatternLayout.java   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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 2f754c6c5d..e66a085c54 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
@@ -744,7 +744,7 @@ public final class PatternLayout extends 
AbstractStringLayout {
 
         /**
          * @param header
-         *        The footer to place at the top of the document, once.
+         *        The header to place at the top of the document, once.
          */
         public Builder withHeader(final String header) {
             this.header = header;