From 1f391b01cfdb9fb960fa747d7c3fa1f085e7c267 Mon Sep 17 00:00:00 2001 From: Robert Burrell Donkin Date: Thu, 19 Jan 2006 20:59:36 +0000 Subject: [PATCH] Javadoc improvements. Contributed by Boris Unckel. Issue #38174. git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@370633 13f79535-47bb-0310-9956-ffa450edef68 --- .../commons/logging/impl/Log4J13Logger.java | 66 +++++++++++++++---- 1 file changed, 54 insertions(+), 12 deletions(-) diff --git a/src/java/org/apache/commons/logging/impl/Log4J13Logger.java b/src/java/org/apache/commons/logging/impl/Log4J13Logger.java index ac770ff..07bb2f2 100644 --- a/src/java/org/apache/commons/logging/impl/Log4J13Logger.java +++ b/src/java/org/apache/commons/logging/impl/Log4J13Logger.java @@ -98,7 +98,10 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log a message to the Log4j Logger with TRACE priority. + * Logs a message with org.apache.log4j.Level.TRACE. + * + * @param message to log + * @see org.apache.commons.logging.Log#trace(Object) */ public void trace(Object message) { getLogger().log(FQCN, Level.TRACE, message, null ); @@ -106,7 +109,11 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log an error to the Log4j Logger with TRACE priority. + * Logs a message with org.apache.log4j.Level.TRACE. + * + * @param message to log + * @param t log this cause + * @see org.apache.commons.logging.Log#trace(Object, Throwable) */ public void trace(Object message, Throwable t) { getLogger().log(FQCN, Level.TRACE, message, t ); @@ -114,14 +121,21 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log a message to the Log4j Logger with DEBUG priority. + * Logs a message with org.apache.log4j.Level.DEBUG. + * + * @param message to log + * @see org.apache.commons.logging.Log#debug(Object) */ public void debug(Object message) { getLogger().log(FQCN, Level.DEBUG, message, null ); } /** - * Log an error to the Log4j Logger with DEBUG priority. + * Logs a message with org.apache.log4j.Level.DEBUG. + * + * @param message to log + * @param t log this cause + * @see org.apache.commons.logging.Log#debug(Object, Throwable) */ public void debug(Object message, Throwable t) { getLogger().log(FQCN, Level.DEBUG, message, t ); @@ -129,7 +143,10 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log a message to the Log4j Logger with INFO priority. + * Logs a message with org.apache.log4j.Level.INFO. + * + * @param message to log + * @see org.apache.commons.logging.Log#info(Object) */ public void info(Object message) { getLogger().log(FQCN, Level.INFO, message, null ); @@ -137,7 +154,11 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log an error to the Log4j Logger with INFO priority. + * Logs a message with org.apache.log4j.Level.INFO. + * + * @param message to log + * @param t log this cause + * @see org.apache.commons.logging.Log#info(Object, Throwable) */ public void info(Object message, Throwable t) { getLogger().log(FQCN, Level.INFO, message, t ); @@ -145,7 +166,10 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log a message to the Log4j Logger with WARN priority. + * Logs a message with org.apache.log4j.Level.WARN. + * + * @param message to log + * @see org.apache.commons.logging.Log#warn(Object) */ public void warn(Object message) { getLogger().log(FQCN, Level.WARN, message, null ); @@ -153,7 +177,11 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log an error to the Log4j Logger with WARN priority. + * Logs a message with org.apache.log4j.Level.WARN. + * + * @param message to log + * @param t log this cause + * @see org.apache.commons.logging.Log#warn(Object, Throwable) */ public void warn(Object message, Throwable t) { getLogger().log(FQCN, Level.WARN, message, t ); @@ -161,7 +189,10 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log a message to the Log4j Logger with ERROR priority. + * Logs a message with org.apache.log4j.Level.ERROR. + * + * @param message to log + * @see org.apache.commons.logging.Log#error(Object) */ public void error(Object message) { getLogger().log(FQCN, Level.ERROR, message, null ); @@ -169,7 +200,11 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log an error to the Log4j Logger with ERROR priority. + * Logs a message with org.apache.log4j.Level.ERROR. + * + * @param message to log + * @param t log this cause + * @see org.apache.commons.logging.Log#error(Object, Throwable) */ public void error(Object message, Throwable t) { getLogger().log(FQCN, Level.ERROR, message, t ); @@ -177,7 +212,10 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log a message to the Log4j Logger with FATAL priority. + * Logs a message with org.apache.log4j.Level.FATAL. + * + * @param message to log + * @see org.apache.commons.logging.Log#fatal(Object) */ public void fatal(Object message) { getLogger().log(FQCN, Level.FATAL, message, null ); @@ -185,7 +223,11 @@ public class Log4J13Logger implements Log, Serializable { /** - * Log an error to the Log4j Logger with FATAL priority. + * Logs a message with org.apache.log4j.Level.FATAL. + * + * @param message to log + * @param t log this cause + * @see org.apache.commons.logging.Log#fatal(Object, Throwable) */ public void fatal(Object message, Throwable t) { getLogger().log(FQCN, Level.FATAL, message, t );