svn commit: r381838 - /jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/Log.java

[skitching]

Author: skitching
Date: Tue Feb 28 15:57:11 2006
New Revision: 381838

URL: http://svn.apache.org/viewcvs?rev=381838&view=rev
Log:
Trivial javadoc patch to add return type info for isXXXEnabled methods.
Thanks to Boris Unckel for patch; see bugzilla#38783.

Modified:
    
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/Log.java

Modified: 
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/Log.java
URL: 
http://svn.apache.org/viewcvs/jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/Log.java?rev=381838&r1=381837&r2=381838&view=diff
==============================================================================
--- 
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/Log.java
 (original)
+++ 
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/Log.java
 Tue Feb 28 15:57:11 2006
@@ -71,6 +71,8 @@
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than debug. </p>
+     *
+     * @return true if debug is enabled in the underlying logger.
      */
     public boolean isDebugEnabled();
 
@@ -81,6 +83,8 @@
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than error. </p>
+     *
+     * @return true if error is enabled in the underlying logger.
      */
     public boolean isErrorEnabled();
 
@@ -91,6 +95,8 @@
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than fatal. </p>
+     *
+     * @return true if fatal is enabled in the underlying logger.
      */
     public boolean isFatalEnabled();
 
@@ -101,6 +107,8 @@
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than info. </p>
+     *
+     * @return true if info is enabled in the underlying logger.
      */
     public boolean isInfoEnabled();
 
@@ -111,6 +119,8 @@
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than trace. </p>
+     *
+     * @return true if trace is enabled in the underlying logger.
      */
     public boolean isTraceEnabled();
 
@@ -121,6 +131,8 @@
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than warn. </p>
+     *
+     * @return true if warn is enabled in the underlying logger.
      */
     public boolean isWarnEnabled();
 



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]