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

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 <code>TRACE</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.TRACE</code>.
+     *
+     * @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 <code>TRACE</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.TRACE</code>.
+     *
+     * @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 <code>DEBUG</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.DEBUG</code>.
+     *
+     * @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 <code>DEBUG</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.DEBUG</code>.
+     *
+     * @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 <code>INFO</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.INFO</code>.
+     *
+     * @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 <code>INFO</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.INFO</code>.
+     *
+     * @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 <code>WARN</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.WARN</code>.
+     *
+     * @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 <code>WARN</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.WARN</code>.
+     *
+     * @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 <code>ERROR</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.ERROR</code>.
+     *
+     * @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 <code>ERROR</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.ERROR</code>.
+     *
+     * @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 <code>FATAL</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.FATAL</code>.
+     *
+     * @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 <code>FATAL</code> priority.
+     * Logs a message with <code>org.apache.log4j.Level.FATAL</code>.
+     *
+     * @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 );