From c61bf4c76d4f834461cb6c7edb8807cf1dd42519 Mon Sep 17 00:00:00 2001 From: Robert Burrell Donkin Date: Sun, 6 Jun 2004 21:16:04 +0000 Subject: [PATCH] Java doc improvements. Patch contributed by Dennis Lundberg. git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@139042 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/commons/logging/Log.java | 4 ++-- src/java/org/apache/commons/logging/LogFactory.java | 7 ++++--- .../commons/logging/impl/Jdk13LumberjackLogger.java | 8 ++++---- .../org/apache/commons/logging/impl/Jdk14Logger.java | 4 ++-- src/java/org/apache/commons/logging/impl/NoOpLog.java | 4 ++-- src/java/org/apache/commons/logging/package.html | 11 ++++++----- 6 files changed, 20 insertions(+), 18 deletions(-) diff --git a/src/java/org/apache/commons/logging/Log.java b/src/java/org/apache/commons/logging/Log.java index 21691b1..93ff184 100644 --- a/src/java/org/apache/commons/logging/Log.java +++ b/src/java/org/apache/commons/logging/Log.java @@ -57,7 +57,7 @@ package org.apache.commons.logging; * * @author Scott Sanders * @author Rod Waldhoff - * @version $Id: Log.java,v 1.18 2004/02/28 21:46:45 craigmcc Exp $ + * @version $Id: Log.java,v 1.19 2004/06/06 21:16:04 rdonkin Exp $ */ public interface Log { @@ -116,7 +116,7 @@ public interface Log { /** - *

Is warning logging currently enabled?

+ *

Is warn logging currently enabled?

* *

Call this method to prevent having to perform expensive operations * (for example, String concatenation) diff --git a/src/java/org/apache/commons/logging/LogFactory.java b/src/java/org/apache/commons/logging/LogFactory.java index ac89e2d..b33f1b4 100644 --- a/src/java/org/apache/commons/logging/LogFactory.java +++ b/src/java/org/apache/commons/logging/LogFactory.java @@ -42,7 +42,7 @@ import java.util.Properties; * @author Craig R. McClanahan * @author Costin Manolache * @author Richard A. Sitze - * @version $Revision: 1.26 $ $Date: 2004/02/28 21:46:45 $ + * @version $Revision: 1.27 $ $Date: 2004/06/06 21:15:12 $ */ public abstract class LogFactory { @@ -72,8 +72,9 @@ public abstract class LogFactory { "commons-logging.properties"; /** - * JDK1.3+ 'Service Provider' specification - * ( http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html ) + * JDK1.3+ + * 'Service Provider' specification. + * */ protected static final String SERVICE_ID = "META-INF/services/org.apache.commons.logging.LogFactory"; diff --git a/src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java b/src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java index 42f8ded..1858671 100644 --- a/src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java +++ b/src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java @@ -31,14 +31,14 @@ import org.apache.commons.logging.Log; /** *

Implementation of the org.apache.commons.logging.Log - * interfaces that wraps the standard JDK logging mechanisms that are + * interface that wraps the standard JDK logging mechanisms that are * available in SourceForge's Lumberjack for JDKs prior to 1.4.

* * @author Scott Sanders * @author Berin Loritsch * @author Peter Donald * @author Vince Eagen - * @version $Revision: 1.5 $ $Date: 2004/02/28 21:46:45 $ + * @version $Revision: 1.6 $ $Date: 2004/06/06 21:13:43 $ */ public class Jdk13LumberjackLogger implements Log, Serializable { @@ -233,7 +233,7 @@ public class Jdk13LumberjackLogger implements Log, Serializable { /** - * Is tace logging currently enabled? + * Is trace logging currently enabled? */ public boolean isTraceEnabled() { return (getLogger().isLoggable(Level.FINEST)); @@ -241,7 +241,7 @@ public class Jdk13LumberjackLogger implements Log, Serializable { /** - * Is warning logging currently enabled? + * Is warn logging currently enabled? */ public boolean isWarnEnabled() { return (getLogger().isLoggable(Level.WARNING)); diff --git a/src/java/org/apache/commons/logging/impl/Jdk14Logger.java b/src/java/org/apache/commons/logging/impl/Jdk14Logger.java index 1794eac..d56cfde 100644 --- a/src/java/org/apache/commons/logging/impl/Jdk14Logger.java +++ b/src/java/org/apache/commons/logging/impl/Jdk14Logger.java @@ -27,13 +27,13 @@ import org.apache.commons.logging.Log; /** *

Implementation of the org.apache.commons.logging.Log - * interfaces that wraps the standard JDK logging mechanisms that were + * interface that wraps the standard JDK logging mechanisms that were * introduced in the Merlin release (JDK 1.4).

* * @author Scott Sanders * @author Berin Loritsch * @author Peter Donald - * @version $Revision: 1.12 $ $Date: 2004/02/28 21:46:45 $ + * @version $Revision: 1.13 $ $Date: 2004/06/06 21:10:21 $ */ public class Jdk14Logger implements Log, Serializable { diff --git a/src/java/org/apache/commons/logging/impl/NoOpLog.java b/src/java/org/apache/commons/logging/impl/NoOpLog.java index c80b21d..cbef4a7 100644 --- a/src/java/org/apache/commons/logging/impl/NoOpLog.java +++ b/src/java/org/apache/commons/logging/impl/NoOpLog.java @@ -28,7 +28,7 @@ import org.apache.commons.logging.Log; * * @author Scott Sanders * @author Rod Waldhoff - * @version $Id: NoOpLog.java,v 1.7 2004/02/28 23:05:01 craigmcc Exp $ + * @version $Id: NoOpLog.java,v 1.8 2004/06/06 21:13:12 rdonkin Exp $ */ public class NoOpLog implements Log, Serializable { @@ -97,7 +97,7 @@ public class NoOpLog implements Log, Serializable { public final boolean isTraceEnabled() { return false; } /** - * Warning is never enabled. + * Warn is never enabled. * * @return false */ diff --git a/src/java/org/apache/commons/logging/package.html b/src/java/org/apache/commons/logging/package.html index b631a5b..ab03c66 100644 --- a/src/java/org/apache/commons/logging/package.html +++ b/src/java/org/apache/commons/logging/package.html @@ -26,14 +26,14 @@ can be used around a variety of different logging implementations, including prebuilt support for the following: