You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rg...@apache.org on 2020/03/29 07:36:16 UTC
[logging-log4j2] branch master updated: Fix javadoc issues and fix
dependency error
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 b75aa08 Fix javadoc issues and fix dependency error
b75aa08 is described below
commit b75aa08da126340e929322887c3ef9e484f87620
Author: Ralph Goers <rg...@apache.org>
AuthorDate: Sun Mar 29 00:36:04 2020 -0700
Fix javadoc issues and fix dependency error
---
.../main/java/org/apache/log4j/WriterAppender.java | 10 +++++++---
.../apache/log4j/bridge/RewritePolicyAdapter.java | 1 +
.../java/org/apache/log4j/or/ObjectRenderer.java | 2 ++
.../main/java/org/apache/log4j/spi/Configurator.java | 4 +++-
.../main/java/org/apache/log4j/spi/LocationInfo.java | 20 ++++++++++++--------
.../java/org/apache/log4j/xml/XmlConfiguration.java | 8 ++++++++
pom.xml | 2 +-
7 files changed, 34 insertions(+), 13 deletions(-)
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/WriterAppender.java b/log4j-1.2-api/src/main/java/org/apache/log4j/WriterAppender.java
index 147990f..546ed44 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/WriterAppender.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/WriterAppender.java
@@ -53,7 +53,7 @@ public class WriterAppender extends AppenderSkeleton {
/**
* The encoding to use when writing. <p>The
- * <code>encoding</code> variable is set to <code>null</null> by
+ * <code>encoding</code> variable is set to <code>null</code> by
* default which results in the utilization of the system's default
* encoding.
*/
@@ -76,17 +76,21 @@ public class WriterAppender extends AppenderSkeleton {
* Instantiate a WriterAppender and set the output destination to a
* new {@link OutputStreamWriter} initialized with <code>os</code>
* as its {@link OutputStream}.
+ * @param layout The Layout.
+ * @param os The OutputStream.
*/
public WriterAppender(Layout layout, OutputStream os) {
this(layout, new OutputStreamWriter(os));
}
/**
- * Instantiate a WriterAppender and set the output destination to
- * <code>writer</code>.
+ * Instantiate a WriterAppender and set the output destination to <code>writer</code>.
*
* <p>The <code>writer</code> must have been previously opened by
* the user.
+ *
+ * @param layout The Layout.
+ * @param writer The Writer.
*/
public WriterAppender(Layout layout, Writer writer) {
this.layout = layout;
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/RewritePolicyAdapter.java b/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/RewritePolicyAdapter.java
index cf0b42b..cd03754 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/RewritePolicyAdapter.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/bridge/RewritePolicyAdapter.java
@@ -30,6 +30,7 @@ public class RewritePolicyAdapter implements org.apache.logging.log4j.core.appen
/**
* Constructor.
+ * @param policy The Rewrite policy.
*/
public RewritePolicyAdapter(RewritePolicy policy) {
this.policy = policy;
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/or/ObjectRenderer.java b/log4j-1.2-api/src/main/java/org/apache/log4j/or/ObjectRenderer.java
index f3fed18..4e627c2 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/or/ObjectRenderer.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/or/ObjectRenderer.java
@@ -22,6 +22,8 @@ package org.apache.log4j.or;
public interface ObjectRenderer {
/**
* Render the object passed as parameter as a String.
+ * @param o The object to render.
+ * @return The String representation of the object.
*/
String doRender(Object o);
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/Configurator.java b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/Configurator.java
index b418db8..55d19da 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/Configurator.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/Configurator.java
@@ -37,7 +37,8 @@ public interface Configurator {
The configuration is done relative to the <code>hierarchy</code>
parameter.
- @param inputStream The InputStream to parse
+ @param inputStream The InputStream to parse.
+ @param loggerContext The LoggerContext.
@since 1.2.17
*/
@@ -50,6 +51,7 @@ public interface Configurator {
parameter.
@param url The URL to parse
+ @param loggerContext The LoggerContext.
*/
void doConfigure(URL url, final LoggerContext loggerContext);
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/LocationInfo.java b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/LocationInfo.java
index 2102802..df49fa9 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/LocationInfo.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/LocationInfo.java
@@ -27,6 +27,10 @@ public class LocationInfo implements java.io.Serializable {
public String fullInfo;
+ /**
+ * Constructor for LocationInfo.
+ * @param element The StackTraceElement representing the caller.
+ */
public LocationInfo(StackTraceElement element) {
this.element = element;
}
@@ -43,33 +47,33 @@ public class LocationInfo implements java.io.Serializable {
/**
Return the fully qualified class name of the caller making the
logging request.
+ @return The class name.
*/
- public
- String getClassName() {
+ public String getClassName() {
return element.getClassName();
}
/**
Return the file name of the caller.
+ @return the file name.
*/
- public
- String getFileName() {
+ public String getFileName() {
return element.getFileName();
}
/**
Returns the line number of the caller.
+ @return The line number.
*/
- public
- String getLineNumber() {
+ public String getLineNumber() {
return Integer.toString(element.getLineNumber());
}
/**
Returns the method name of the caller.
+ @return The method name.
*/
- public
- String getMethodName() {
+ public String getMethodName() {
return element.getMethodName();
}
}
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/xml/XmlConfiguration.java b/log4j-1.2-api/src/main/java/org/apache/log4j/xml/XmlConfiguration.java
index 7aee3b3..d532a13 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/xml/XmlConfiguration.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/xml/XmlConfiguration.java
@@ -327,6 +327,8 @@ public class XmlConfiguration extends Log4j1Configuration {
/**
* Used internally to parse appenders by IDREF element.
+ * @param appenderRef The Appender Reference Element.
+ * @return The Appender.
*/
public Appender findAppenderByReference(Element appenderRef) {
String appenderName = subst(appenderRef.getAttribute(REF_ATTR));
@@ -336,6 +338,8 @@ public class XmlConfiguration extends Log4j1Configuration {
/**
* Used internally to parse an appender element.
+ * @param appenderElement The Appender Element.
+ * @return The Appender.
*/
public Appender parseAppender(Element appenderElement) {
String className = subst(appenderElement.getAttribute(CLASS_ATTR));
@@ -477,6 +481,8 @@ public class XmlConfiguration extends Log4j1Configuration {
/**
* Used internally to parse a filter element.
+ * @param filterElement The Filter Element.
+ * @return The Filter.
*/
public Filter parseFilters(Element filterElement) {
String className = subst(filterElement.getAttribute(CLASS_ATTR));
@@ -561,6 +567,8 @@ public class XmlConfiguration extends Log4j1Configuration {
/**
* Used internally to parse a layout element.
+ * @param layoutElement The Layout Element.
+ * @return The Layout.
*/
public Layout parseLayout(Element layoutElement) {
String className = subst(layoutElement.getAttribute(CLASS_ATTR));
diff --git a/pom.xml b/pom.xml
index ee85be0..cfa5d9d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -347,7 +347,7 @@
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j--1.2-api</artifactId>
+ <artifactId>log4j-1.2-api</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>