You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gg...@apache.org on 2012/10/22 18:30:11 UTC

svn commit: r1400943 - in /logging/log4j/log4j2/trunk: api/src/main/java/org/apache/logging/log4j/ api/src/main/java/org/apache/logging/log4j/spi/ core/src/main/java/org/apache/logging/log4j/core/helpers/ log4j12-api/src/main/java/org/apache/log4j/

Author: ggregory
Date: Mon Oct 22 16:30:11 2012
New Revision: 1400943

URL: http://svn.apache.org/viewvc?rev=1400943&view=rev
Log:
Replace "<code>true</code>" with "{@code true}", it's less noisy and shorter.

Modified:
    logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java
    logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java
    logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/helpers/OptionConverter.java
    logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Appender.java
    logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Layout.java
    logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Priority.java

Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java?rev=1400943&r1=1400942&r2=1400943&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java (original)
+++ logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/Logger.java Mon Oct 22 16:30:11 2012
@@ -573,7 +573,7 @@ public interface Logger {
   /**
    * Checks whether this Logger is enabled for the {@link Level#DEBUG DEBUG} Level.
    *
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         DEBUG, {@code false} otherwise.
    */
   boolean isDebugEnabled();
@@ -582,7 +582,7 @@ public interface Logger {
    * Checks whether this Logger is enabled for the {@link Level#DEBUG DEBUG} Level.
    *
    * @param marker The marker data specific to this log statement.
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         DEBUG, {@code false} otherwise.
    */
   boolean isDebugEnabled(Marker marker);
@@ -593,14 +593,14 @@ public interface Logger {
    * Note that passing in {@link Level#OFF OFF} always returns {@code true}.
    * </p>
    * @param level the level to check
-   * @return boolean - <code>true</code> if this Logger is enabled for level, {@code false} otherwise.
+   * @return boolean - {@code true} if this Logger is enabled for level, {@code false} otherwise.
    */
   boolean isEnabled(Level level);
   
   /**
    * Checks whether this Logger is enabled for the {@link Level#ERROR ERROR} Level.
    *
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         {@link Level#ERROR ERROR}, {@code false} otherwise.
    */
   boolean isErrorEnabled();
@@ -609,7 +609,7 @@ public interface Logger {
    * Checks whether this Logger is enabled for the {@link Level#ERROR ERROR} Level.
    *
    * @param marker The marker data specific to this log statement.
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         {@link Level#ERROR ERROR}, {@code false} otherwise.
    */
   boolean isErrorEnabled(Marker marker);
@@ -617,7 +617,7 @@ public interface Logger {
   /**
    * Checks whether this Logger is enabled for the {@link Level#FATAL FATAL} Level.
    *
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         {@link Level#FATAL FATAL}, {@code false} otherwise.
    */
   boolean isFatalEnabled();
@@ -626,7 +626,7 @@ public interface Logger {
    * Checks whether this Logger is enabled for the {@link Level#FATAL FATAL} Level.
    *
    * @param marker The marker data specific to this log statement.
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         {@link Level#FATAL FATAL}, {@code false} otherwise.
    */
   boolean isFatalEnabled(Marker marker);
@@ -634,7 +634,7 @@ public interface Logger {
   /**
    * Checks whether this Logger is enabled for the {@link Level#INFO INFO} Level.
    *
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         INFO, {@code false} otherwise.
    */
   boolean isInfoEnabled();
@@ -643,7 +643,7 @@ public interface Logger {
    * Checks whether this Logger is enabled for the {@link Level#INFO INFO} Level.
    *
    * @param marker The marker data specific to this log statement.
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         INFO, {@code false} otherwise.
    */
   boolean isInfoEnabled(Marker marker);
@@ -651,7 +651,7 @@ public interface Logger {
   /**
    * Checks whether this Logger is enabled for the {@link Level#TRACE TRACE} level.
    *
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         TRACE, {@code false} otherwise.
    */
   boolean isTraceEnabled();
@@ -660,7 +660,7 @@ public interface Logger {
    * Checks whether this Logger is enabled for the {@link Level#TRACE TRACE} level.
    *
    * @param marker The marker data specific to this log statement.
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         TRACE, {@code false} otherwise.
    */
   boolean isTraceEnabled(Marker marker);
@@ -668,7 +668,7 @@ public interface Logger {
   /**
    * Checks whether this Logger is enabled for the {@link Level#WARN WARN} Level.
    *
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         {@link Level#WARN WARN}, {@code false} otherwise.
    */
   boolean isWarnEnabled();
@@ -677,7 +677,7 @@ public interface Logger {
    * Checks whether this Logger is enabled for the {@link Level#WARN WARN} Level.
    *
    * @param marker The marker data specific to this log statement.
-   * @return boolean - <code>true</code> if this Logger is enabled for level
+   * @return boolean - {@code true} if this Logger is enabled for level
    *         {@link Level#WARN WARN}, {@code false} otherwise.
    */
   boolean isWarnEnabled(Marker marker);

Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java?rev=1400943&r1=1400942&r2=1400943&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java (original)
+++ logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java Mon Oct 22 16:30:11 2012
@@ -323,7 +323,7 @@ public abstract class AbstractLogger imp
     /**
      * Checks whether this Logger is enabled for the TRACE  Level.
      *
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         TRACE, {@code false} otherwise.
      */
     public boolean isTraceEnabled() {
@@ -334,7 +334,7 @@ public abstract class AbstractLogger imp
      * Checks whether this Logger is enabled for the TRACE  Level.
      *
      * @param marker The marker data.
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         TRACE, {@code false} otherwise.
      */
     public boolean isTraceEnabled(Marker marker) {
@@ -518,7 +518,7 @@ public abstract class AbstractLogger imp
     /**
      * Checks whether this Logger is enabled for the DEBUG Level.
      *
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         DEBUG, {@code false} otherwise.
      */
     public boolean isDebugEnabled() {
@@ -529,7 +529,7 @@ public abstract class AbstractLogger imp
      * Checks whether this Logger is enabled for the DEBUG Level.
      *
      * @param marker The marker data.
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         DEBUG, {@code false} otherwise.
      */
     public boolean isDebugEnabled(Marker marker) {
@@ -715,7 +715,7 @@ public abstract class AbstractLogger imp
     /**
      * Checks whether this Logger is enabled for the INFO Level.
      *
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         INFO, {@code false} otherwise.
      */
     public boolean isInfoEnabled() {
@@ -725,7 +725,7 @@ public abstract class AbstractLogger imp
     /**
      * Checks whether this Logger is enabled for the INFO Level.
      * @param marker The marker data.
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         INFO, {@code false} otherwise.
      */
     public boolean isInfoEnabled(Marker marker) {
@@ -910,7 +910,7 @@ public abstract class AbstractLogger imp
     /**
      * Checks whether this Logger is enabled for the WARN Level.
      *
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         WARN, {@code false} otherwise.
      */
     public boolean isWarnEnabled() {
@@ -922,7 +922,7 @@ public abstract class AbstractLogger imp
      * Checks whether this Logger is enabled for the WARN Level.
      *
      * @param marker The marker data.
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         WARN, {@code false} otherwise.
      */
     public boolean isWarnEnabled(Marker marker) {
@@ -1108,7 +1108,7 @@ public abstract class AbstractLogger imp
     /**
      * Checks whether this Logger is enabled for the {@link Level#ERROR ERROR} Level.
      *
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         {@link Level#ERROR ERROR}, {@code false} otherwise.
      */
     public boolean isErrorEnabled() {
@@ -1119,7 +1119,7 @@ public abstract class AbstractLogger imp
      * Checks whether this Logger is enabled for the {@link Level#ERROR ERROR} Level.
      *
      * @param marker The marker data.
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         {@link Level#ERROR ERROR}, {@code false} otherwise.
      */
     public boolean isErrorEnabled(Marker marker) {
@@ -1305,7 +1305,7 @@ public abstract class AbstractLogger imp
     /**
      * Checks whether this Logger is enabled for the FATAL Level.
      *
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         FATAL, {@code false} otherwise.
      */
     public boolean isFatalEnabled() {
@@ -1316,7 +1316,7 @@ public abstract class AbstractLogger imp
      * Checks whether this Logger is enabled for the FATAL Level.
      *
      * @param marker The marker data.
-     * @return boolean - <code>true</code> if this Logger is enabled for level
+     * @return boolean - {@code true} if this Logger is enabled for level
      *         FATAL, {@code false} otherwise.
      */
     public boolean isFatalEnabled(Marker marker) {
@@ -1433,7 +1433,7 @@ public abstract class AbstractLogger imp
      * Note that passing in {@link Level#OFF OFF} always returns {@code true}.
      * </p>
      * @param level the level to check
-     * @return boolean - <code>true</code> if this Logger is enabled for level, {@code false} otherwise.
+     * @return boolean - {@code true} if this Logger is enabled for level, {@code false} otherwise.
      */
     public boolean isEnabled(Level level) {
         return isEnabled(level, null, (Object) null, null);

Modified: logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/helpers/OptionConverter.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/helpers/OptionConverter.java?rev=1400943&r1=1400942&r2=1400943&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/helpers/OptionConverter.java (original)
+++ logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/helpers/OptionConverter.java Mon Oct 22 16:30:11 2012
@@ -118,9 +118,9 @@ public final class OptionConverter {
     }
 
     /**
-     * If <code>value</code> is "true", then <code>true</code> is
+     * If <code>value</code> is "true", then {@code true} is
      * returned. If <code>value</code> is "false", then
-     * <code>true</code> is returned. Otherwise, <code>default</code> is
+     * {@code true} is returned. Otherwise, <code>default</code> is
      * returned.
      * <p/>
      * <p>Case of value is unimportant.

Modified: logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Appender.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Appender.java?rev=1400943&r1=1400942&r2=1400943&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Appender.java (original)
+++ logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Appender.java Mon Oct 22 16:30:11 2012
@@ -116,7 +116,7 @@ public interface Appender {
 
     /**
      * Configurators call this method to determine if the appender
-     * requires a layout. If this method returns <code>true</code>,
+     * requires a layout. If this method returns {@code true},
      * meaning that layout is required, then the configurator will
      * configure an layout using the configuration information at its
      * disposal.  If this method returns {@code false}, meaning that
@@ -126,7 +126,7 @@ public interface Appender {
      * <p/>
      * <p>In the rather exceptional case, where the appender
      * implementation admits a layout but can also work without it, then
-     * the appender should return <code>true</code>.
+     * the appender should return {@code true}.
      *
      * @since 0.8.4
      */

Modified: logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Layout.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Layout.java?rev=1400943&r1=1400942&r2=1400943&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Layout.java (original)
+++ logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Layout.java Mon Oct 22 16:30:11 2012
@@ -63,12 +63,12 @@ public abstract class Layout {
      * If the layout handles the throwable object contained within
      * {@link LoggingEvent}, then the layout should return
      * {@code false}. Otherwise, if the layout ignores throwable
-     * object, then the layout should return <code>true</code>.
+     * object, then the layout should return {@code true}.
      * If ignoresThrowable is true, the appender is responsible for
      * rendering the throwable.
      * <p/>
      * <p>The {@link SimpleLayout}, {@link TTCCLayout}, {@link
-     * PatternLayout} all return <code>true</code>. The {@link
+     * PatternLayout} all return {@code true}. The {@link
      * org.apache.log4j.xml.XMLLayout} returns {@code false}.
      *
      * @since 0.8.4

Modified: logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Priority.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Priority.java?rev=1400943&r1=1400942&r2=1400943&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Priority.java (original)
+++ logging/log4j/log4j2/trunk/log4j12-api/src/main/java/org/apache/log4j/Priority.java Mon Oct 22 16:30:11 2012
@@ -146,7 +146,7 @@ public class Priority {
 
 
     /**
-     * Returns <code>true</code> if this level has a higher or equal
+     * Returns {@code true} if this level has a higher or equal
      * level than the level passed as argument, {@code false}
      * otherwise.
      * <p/>