diff --git a/src/java/org/apache/commons/logging/impl/AvalonLogger.java b/src/java/org/apache/commons/logging/impl/AvalonLogger.java index 9d3f413..a2eed5f 100644 --- a/src/java/org/apache/commons/logging/impl/AvalonLogger.java +++ b/src/java/org/apache/commons/logging/impl/AvalonLogger.java @@ -21,19 +21,40 @@ import org.apache.avalon.framework.logger.Logger; import org.apache.commons.logging.Log; /** - * Implementation of commons-logging Log interface that delegates all + *
Implementation of commons-logging Log interface that delegates all * logging calls to the Avalon logging abstraction: the Logger interface. + *
+ *+ * There are two ways in which this class can be used: + *
+ *AvalonLogger
+ * instances created through the LogFactory mechanisms will output
+ * to child loggers of this Logger.
+ * AvalonLogger that outputs to the given
+ * Logger instance.
* @param logger the avalon logger implementation to delegate to
*/
public AvalonLogger(Logger logger) {
@@ -42,6 +63,8 @@ public class AvalonLogger implements Log, Serializable {
}
/**
+ * Constructs an AvalonLogger that will log to a child
+ * of the Logger set by calling {@link #setDefaultLogger}.
* @param name the name of the avalon logger implementation to delegate to
*/
public AvalonLogger(String name) {
@@ -51,6 +74,7 @@ public class AvalonLogger implements Log, Serializable {
}
/**
+ * Gets the Avalon logger implementation used to perform logging.
* @return avalon logger implementation
*/
public Logger getLogger() {
@@ -61,7 +85,10 @@ public class AvalonLogger implements Log, Serializable {
}
/**
- * @param logger the default avalon logger, in case there is no logger instance supplied in constructor
+ * Sets the ancesteral Avalon logger from which the delegating loggers
+ * will descend.
+ * @param logger the default avalon logger,
+ * in case there is no logger instance supplied in constructor
*/
public static void setDefaultLogger(Logger logger) {
defaultLogger = logger;
diff --git a/src/java/org/apache/commons/logging/impl/LogKitLogger.java b/src/java/org/apache/commons/logging/impl/LogKitLogger.java
index 5e694a1..c904ed1 100644
--- a/src/java/org/apache/commons/logging/impl/LogKitLogger.java
+++ b/src/java/org/apache/commons/logging/impl/LogKitLogger.java
@@ -33,8 +33,8 @@ import org.apache.commons.logging.Log;
* by called their toString() method before logging them.
*
* @author Scott Sanders
- * @author Robert Burrell Donkin *
- * @version $Id: LogKitLogger.java,v 1.8 2004/02/28 21:46:45 craigmcc Exp $
+ * @author Robert Burrell Donkin
+ * @version $Id: LogKitLogger.java,v 1.9 2004/06/01 19:56:46 rdonkin Exp $
*/
public class LogKitLogger implements Log, Serializable {