Return-Path: X-Original-To: apmail-logging-commits-archive@minotaur.apache.org Delivered-To: apmail-logging-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 3D5D4D112 for ; Mon, 22 Oct 2012 16:31:01 +0000 (UTC) Received: (qmail 43494 invoked by uid 500); 22 Oct 2012 16:31:01 -0000 Delivered-To: apmail-logging-commits-archive@logging.apache.org Received: (qmail 43467 invoked by uid 500); 22 Oct 2012 16:31:01 -0000 Mailing-List: contact commits-help@logging.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@logging.apache.org Delivered-To: mailing list commits@logging.apache.org Received: (qmail 43458 invoked by uid 99); 22 Oct 2012 16:31:01 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 22 Oct 2012 16:31:01 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 22 Oct 2012 16:30:56 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id DF4902388962; Mon, 22 Oct 2012 16:30:11 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: 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/ Date: Mon, 22 Oct 2012 16:30:11 -0000 To: commits@logging.apache.org From: ggregory@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121022163011.DF4902388962@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org 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 "true" 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 - true 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 - true 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}. *

* @param level the level to check - * @return boolean - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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 - true 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}. *

* @param level the level to check - * @return boolean - true 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 value is "true", then true is + * If value is "true", then {@code true} is * returned. If value is "false", then - * true is returned. Otherwise, default is + * {@code true} is returned. Otherwise, default is * returned. *

*

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 true, + * 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 { *

*

In the rather exceptional case, where the appender * implementation admits a layout but can also work without it, then - * the appender should return true. + * 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 true. + * object, then the layout should return {@code true}. * If ignoresThrowable is true, the appender is responsible for * rendering the throwable. *

*

The {@link SimpleLayout}, {@link TTCCLayout}, {@link - * PatternLayout} all return true. 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 true 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. *