[logging-log4j2] branch master updated: LOG4J2-2814 - Fix Javadoc in ScriptPatternSelector

[rg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rgoers pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/master by this push:
     new 5058663  LOG4J2-2814 - Fix Javadoc in ScriptPatternSelector
5058663 is described below

commit 5058663aee5764a2dad52b65712e20eab1c2a020
Author: Ralph Goers <rg...@apache.org>
AuthorDate: Thu Apr 16 21:38:41 2020 -0700

    LOG4J2-2814 - Fix Javadoc in ScriptPatternSelector
---
 .../org/apache/logging/log4j/core/layout/ScriptPatternSelector.java   | 4 +++-
 src/changes/changes.xml                                               | 3 +++
 2 files changed, 6 insertions(+), 1 deletion(-)

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 7e18ab1..35bba99 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
@@ -37,7 +37,9 @@ import java.util.List;
 import java.util.Map;
 
 /**
- * Selects the pattern to use based on the Marker in the LogEvent.
+ * Selects the pattern to use based on the result of executing a Script. The returned value will be used as the "key"
+ * to choose between one of the configured patterns. If no key is returned or there is no match the default
+ * pattern will be used.
  */
 @Plugin(name = "ScriptPatternSelector", category = Node.CATEGORY, elementType = PatternSelector.ELEMENT_TYPE, printObject = true)
 public class ScriptPatternSelector implements PatternSelector {
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index d01bc1c..b8783e2 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -169,6 +169,9 @@
       </action>
     </release>
     <release version="2.13.2" date="2020-MM-DD" description="GA Release 2.13.2">
+      <action issue="LOG4J2-2814" dev="rgoers" type="fix">
+        Fix Javadoc for ScriptPatternSelector.
+      </action>
       <action issue="LOG4J2-2793" dev="rgoers" type="fix" due-to="Renukaprasad C">
         Allow trailing and leading spaces in log level.
       </action>