Author: ggregory Date: Wed Mar 28 15:32:09 2012 New Revision: 1306423 URL: http://svn.apache.org/viewvc?rev=1306423&view=rev Log: Replace "<code>true</code>" with "{@code true}"
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java Wed Mar 28 15:32:09 2012 @@ -167,7 +167,7 @@ public class Base32 extends BaseNCodec { * <p> * When encoding the line length is 0 (no chunking). * </p> - * @param useHex if <code>true</code> then use Base32 Hex alphabet + * @param useHex if {@code true} then use Base32 Hex alphabet */ public Base32(boolean useHex) { this(0, null, useHex); @@ -222,7 +222,7 @@ public class Base32 extends BaseNCodec { * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding. * @param lineSeparator * Each line of encoded data will end with this sequence of bytes. - * @param useHex if <code>true</code>, then use Base32 Hex alphabet, otherwise use Base32 alphabet + * @param useHex if {@code true}, then use Base32 Hex alphabet, otherwise use Base32 alphabet * @throws IllegalArgumentException * The provided lineSeparator included some Base32 characters. That's not going to work! * Or the lineLength > 0 and lineSeparator is null. @@ -464,7 +464,7 @@ public class Base32 extends BaseNCodec { * * @param octet * The value to test - * @return <code>true</code> if the value is defined in the the Base32 alphabet <code>false</code> otherwise. + * @return {@code true} if the value is defined in the the Base32 alphabet <code>false</code> otherwise. */ @Override public boolean isInAlphabet(byte octet) { Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java Wed Mar 28 15:32:09 2012 @@ -187,7 +187,7 @@ public class Base64 extends BaseNCodec { * </p> * * @param urlSafe - * if <code>true</code>, URL-safe encoding is used. In most cases this should be set to + * if {@code true}, URL-safe encoding is used. In most cases this should be set to * <code>false</code>. * @since 1.4 */ @@ -473,7 +473,7 @@ public class Base64 extends BaseNCodec { * * @param arrayOctet * byte array to test - * @return <code>true</code> if all bytes are valid characters in the Base64 alphabet or if the byte array is empty; + * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty; * <code>false</code>, otherwise * @deprecated 1.5 Use {@link #isBase64(byte[])}, will be removed in 2.0. */ @@ -486,7 +486,7 @@ public class Base64 extends BaseNCodec { * * @param octet * The value to test - * @return <code>true</code> if the value is defined in the the base 64 alphabet, <code>false</code> otherwise. + * @return {@code true} if the value is defined in the the base 64 alphabet, <code>false</code> otherwise. * @since 1.4 */ public static boolean isBase64(byte octet) { @@ -499,7 +499,7 @@ public class Base64 extends BaseNCodec { * * @param base64 * String to test - * @return <code>true</code> if all characters in the String are valid characters in the Base64 alphabet or if + * @return {@code true} if all characters in the String are valid characters in the Base64 alphabet or if * the String is empty; <code>false</code>, otherwise * @since 1.5 */ @@ -513,7 +513,7 @@ public class Base64 extends BaseNCodec { * * @param arrayOctet * byte array to test - * @return <code>true</code> if all bytes are valid characters in the Base64 alphabet or if the byte array is empty; + * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty; * <code>false</code>, otherwise * @since 1.5 */ @@ -595,7 +595,7 @@ public class Base64 extends BaseNCodec { * @param binaryData * Array containing binary data to encode. * @param isChunked - * if <code>true</code> this encoder will chunk the base64 output into 76 character blocks + * if {@code true} this encoder will chunk the base64 output into 76 character blocks * @return Base64-encoded data. * @throws IllegalArgumentException * Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE} @@ -610,9 +610,9 @@ public class Base64 extends BaseNCodec { * @param binaryData * Array containing binary data to encode. * @param isChunked - * if <code>true</code> this encoder will chunk the base64 output into 76 character blocks + * if {@code true} this encoder will chunk the base64 output into 76 character blocks * @param urlSafe - * if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters. + * if {@code true} this encoder will emit - and _ instead of the usual + and / characters. * @return Base64-encoded data. * @throws IllegalArgumentException * Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE} @@ -628,9 +628,9 @@ public class Base64 extends BaseNCodec { * @param binaryData * Array containing binary data to encode. * @param isChunked - * if <code>true</code> this encoder will chunk the base64 output into 76 character blocks + * if {@code true} this encoder will chunk the base64 output into 76 character blocks * @param urlSafe - * if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters. + * if {@code true} this encoder will emit - and _ instead of the usual + and / characters. * @param maxResultSize * The maximum result size to accept. * @return Base64-encoded data. @@ -748,7 +748,7 @@ public class Base64 extends BaseNCodec { * * @param octet * The value to test - * @return <code>true</code> if the value is defined in the the Base32 alphabet <code>false</code> otherwise. + * @return {@code true} if the value is defined in the the Base32 alphabet <code>false</code> otherwise. */ @Override protected boolean isInAlphabet(byte octet) { Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java Wed Mar 28 15:32:09 2012 @@ -372,7 +372,7 @@ public abstract class BaseNCodec impleme * * @param value The value to test * - * @return <code>true</code> if the value is defined in the current alphabet, <code>false</code> otherwise. + * @return {@code true} if the value is defined in the current alphabet, <code>false</code> otherwise. */ protected abstract boolean isInAlphabet(byte value); @@ -381,9 +381,9 @@ public abstract class BaseNCodec impleme * The method optionally treats whitespace and pad as valid. * * @param arrayOctet byte array to test - * @param allowWSPad if <code>true</code>, then whitespace and PAD are also allowed + * @param allowWSPad if {@code true}, then whitespace and PAD are also allowed * - * @return <code>true</code> if all bytes are valid characters in the alphabet or if the byte array is empty; + * @return {@code true} if all bytes are valid characters in the alphabet or if the byte array is empty; * <code>false</code>, otherwise */ public boolean isInAlphabet(byte[] arrayOctet, boolean allowWSPad) { @@ -401,7 +401,7 @@ public abstract class BaseNCodec impleme * The method treats whitespace and PAD as valid. * * @param basen String to test - * @return <code>true</code> if all characters in the String are valid characters in the alphabet or if + * @return {@code true} if all characters in the String are valid characters in the alphabet or if * the String is empty; <code>false</code>, otherwise * @see #isInAlphabet(byte[], boolean) */ @@ -416,7 +416,7 @@ public abstract class BaseNCodec impleme * * @param arrayOctet * byte array to test - * @return <code>true</code> if any byte is a valid character in the alphabet or PAD; <code>false</code> otherwise + * @return {@code true} if any byte is a valid character in the alphabet or PAD; <code>false</code> otherwise */ protected boolean containsAlphabetOrPad(byte[] arrayOctet) { if (arrayOctet == null) { Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java Wed Mar 28 15:32:09 2012 @@ -211,11 +211,11 @@ public class BinaryCodec implements Bina } /** - * Returns <code>true</code> if the given array is {@code null} or empty (size 0.) + * Returns {@code true} if the given array is {@code null} or empty (size 0.) * * @param array * the source array - * @return <code>true</code> if the given array is {@code null} or empty (size 0.) + * @return {@code true} if the given array is {@code null} or empty (size 0.) */ private static boolean isEmpty(byte[] array) { return array == null || array.length == 0; Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java Wed Mar 28 15:32:09 2012 @@ -115,7 +115,7 @@ public class Hex implements BinaryEncode * @param data * a byte[] to convert to Hex characters * @param toLowerCase - * <code>true</code> converts to lowercase, <code>false</code> to uppercase + * {@code true} converts to lowercase, <code>false</code> to uppercase * @return A char[] containing hexadecimal characters * @since 1.4 */ Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java Wed Mar 28 15:32:09 2012 @@ -67,7 +67,7 @@ public abstract class AbstractCaverphone * First of two strings to compare * @param str2 * Second of two strings to compare - * @return <code>true</code> if the encodings of these strings are identical, <code>false</code> otherwise. + * @return {@code true} if the encodings of these strings are identical, <code>false</code> otherwise. * @throws EncoderException */ public boolean isEncodeEqual(String str1, String str2) throws EncoderException { Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java Wed Mar 28 15:32:09 2012 @@ -94,7 +94,7 @@ public class Caverphone implements Strin * First of two strings to compare * @param str2 * Second of two strings to compare - * @return <code>true</code> if the caverphones of these strings are identical, <code>false</code> otherwise. + * @return {@code true} if the caverphones of these strings are identical, <code>false</code> otherwise. */ public boolean isCaverphoneEqual(String str1, String str2) { return this.caverphone(str1).equals(this.caverphone(str2)); Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java Wed Mar 28 15:32:09 2012 @@ -217,7 +217,7 @@ public class DoubleMetaphone implements * * @param value1 The left-hand side of the encoded {@link String#equals(Object)}. * @param value2 The right-hand side of the encoded {@link String#equals(Object)}. - * @return <code>true</code> if the encoded <code>String</code>s are equal; + * @return {@code true} if the encoded <code>String</code>s are equal; * <code>false</code> otherwise. * @see #isDoubleMetaphoneEqual(String,String,boolean) */ @@ -231,8 +231,8 @@ public class DoubleMetaphone implements * * @param value1 The left-hand side of the encoded {@link String#equals(Object)}. * @param value2 The right-hand side of the encoded {@link String#equals(Object)}. - * @param alternate use the alternate value if <code>true</code>. - * @return <code>true</code> if the encoded <code>String</code>s are equal; + * @param alternate use the alternate value if {@code true}. + * @return {@code true} if the encoded <code>String</code>s are equal; * <code>false</code> otherwise. */ public boolean isDoubleMetaphoneEqual(String value1, @@ -896,7 +896,7 @@ public class DoubleMetaphone implements /** * Determines whether or not the value starts with a silent letter. It will - * return <code>true</code> if the value starts with any of 'GN', 'KN', + * return {@code true} if the value starts with any of 'GN', 'KN', * 'PN', 'WR' or 'PS'. */ private boolean isSilentStart(String value) { Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java Wed Mar 28 15:32:09 2012 @@ -385,7 +385,7 @@ public class Metaphone implements String * * @param str1 First of two strings to compare * @param str2 Second of two strings to compare - * @return <code>true</code> if the metaphones of these strings are identical, + * @return {@code true} if the metaphones of these strings are identical, * <code>false</code> otherwise. */ public boolean isMetaphoneEqual(String str1, String str2) { Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java Wed Mar 28 15:32:09 2012 @@ -95,7 +95,7 @@ public class Nysiis implements StringEnc * * @param c * the character to test - * @return <code>true</code> if the character is a vowel, <code>false</code> otherwise + * @return {@code true} if the character is a vowel, <code>false</code> otherwise */ private static boolean isVowel(final char c) { return c == 'A' || c == 'E' || c == 'I' || c == 'O' || c == 'U'; @@ -182,7 +182,7 @@ public class Nysiis implements StringEnc * Create an instance of the {@link Nysiis} encoder with the specified strict mode: * * <ul> - * <li><code>true</code>: encoded strings have a maximum length of 6</li> + * <li>{@code true}: encoded strings have a maximum length of 6</li> * <li><code>false</code>: encoded strings may have arbitrary length</li> * </ul> * @@ -229,7 +229,7 @@ public class Nysiis implements StringEnc /** * Indicates the strict mode for this {@link Nysiis} encoder. * - * @return <code>true</code> if the encoder is configured for strict mode, <code>false</code> otherwise + * @return {@code true} if the encoder is configured for strict mode, <code>false</code> otherwise */ public boolean isStrict() { return this.strict; Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java?rev=1306423&r1=1306422&r2=1306423&view=diff ============================================================================== --- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java (original) +++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java Wed Mar 28 15:32:09 2012 @@ -341,7 +341,7 @@ public class QCodec extends RFC1522Codec /** * Tests if optional transformation of SPACE characters is to be used * - * @return <code>true</code> if SPACE characters are to be transformed, <code>false</code> otherwise + * @return {@code true} if SPACE characters are to be transformed, <code>false</code> otherwise */ public boolean isEncodeBlanks() { return this.encodeBlanks; @@ -351,7 +351,7 @@ public class QCodec extends RFC1522Codec * Defines whether optional transformation of SPACE characters is to be used * * @param b - * <code>true</code> if SPACE characters are to be transformed, <code>false</code> otherwise + * {@code true} if SPACE characters are to be transformed, <code>false</code> otherwise */ public void setEncodeBlanks(boolean b) { this.encodeBlanks = b;