commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1306424 - in /commons/proper/codec/trunk/src/main/java/org/apache/commons/codec: binary/ language/ net/
Date Wed, 28 Mar 2012 15:32:49 GMT
Author: ggregory
Date: Wed Mar 28 15:32:48 2012
New Revision: 1306424

URL: http://svn.apache.org/viewvc?rev=1306424&view=rev
Log:
Replace "<code>false</code>" with "{@code false}"

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/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=1306424&r1=1306423&r2=1306424&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:48 2012
@@ -464,7 +464,7 @@ public class Base32 extends BaseNCodec {
      * 
      * @param octet
      *            The value to test
-     * @return {@code true} 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}
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=1306424&r1=1306423&r2=1306424&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:48 2012
@@ -188,7 +188,7 @@ public class Base64 extends BaseNCodec {
      * 
      * @param urlSafe
      *            if {@code true}, URL-safe encoding is used. In most cases this should be
set to
-     *            <code>false</code>.
+     *            {@code false}.
      * @since 1.4
      */
     public Base64(boolean urlSafe) {
@@ -474,7 +474,7 @@ public class Base64 extends BaseNCodec {
      * @param arrayOctet
      *            byte array to test
      * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if
the byte array is empty;
-     *         <code>false</code>, otherwise
+     *         {@code false}, otherwise
      * @deprecated 1.5 Use {@link #isBase64(byte[])}, will be removed in 2.0.
      */
     public static boolean isArrayByteBase64(byte[] arrayOctet) {
@@ -486,7 +486,7 @@ public class Base64 extends BaseNCodec {
      * 
      * @param octet
      *            The value to test
-     * @return {@code true} 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}
otherwise.
      * @since 1.4
      */
     public static boolean isBase64(byte octet) {
@@ -500,7 +500,7 @@ public class Base64 extends BaseNCodec {
      * @param base64
      *            String to test
      * @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
+     *         the String is empty; {@code false}, otherwise
      *  @since 1.5
      */
     public static boolean isBase64(String base64) {
@@ -514,7 +514,7 @@ public class Base64 extends BaseNCodec {
      * @param arrayOctet
      *            byte array to test
      * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if
the byte array is empty;
-     *         <code>false</code>, otherwise
+     *         {@code false}, otherwise
      * @since 1.5
      */    
     public static boolean isBase64(byte[] arrayOctet) {
@@ -748,7 +748,7 @@ public class Base64 extends BaseNCodec {
      * 
      * @param octet
      *            The value to test
-     * @return {@code true} 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}
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=1306424&r1=1306423&r2=1306424&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:48 2012
@@ -372,7 +372,7 @@ public abstract class BaseNCodec impleme
      *
      * @param value The value to test
      *
-     * @return {@code true} 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}
otherwise.
      */
     protected abstract boolean isInAlphabet(byte value);
     
@@ -384,7 +384,7 @@ public abstract class BaseNCodec impleme
      * @param allowWSPad if {@code true}, then whitespace and PAD are also allowed
      *
      * @return {@code true} if all bytes are valid characters in the alphabet or if the byte
array is empty;
-     *         <code>false</code>, otherwise
+     *         {@code false}, otherwise
      */    
     public boolean isInAlphabet(byte[] arrayOctet, boolean allowWSPad) {
         for (int i = 0; i < arrayOctet.length; i++) {
@@ -402,7 +402,7 @@ public abstract class BaseNCodec impleme
      *
      * @param basen String to test
      * @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
+     *         the String is empty; {@code false}, otherwise
      * @see #isInAlphabet(byte[], boolean)
      */
     public boolean isInAlphabet(String basen) {
@@ -416,7 +416,7 @@ public abstract class BaseNCodec impleme
      *
      * @param arrayOctet
      *            byte array to test
-     * @return {@code true} 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} otherwise
      */
     protected boolean containsAlphabetOrPad(byte[] arrayOctet) {
         if (arrayOctet == null) {

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=1306424&r1=1306423&r2=1306424&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:48 2012
@@ -115,7 +115,7 @@ public class Hex implements BinaryEncode
      * @param data
      *            a byte[] to convert to Hex characters
      * @param toLowerCase
-     *            {@code true} converts to lowercase, <code>false</code> to uppercase
+     *            {@code true} converts to lowercase, {@code false} 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=1306424&r1=1306423&r2=1306424&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:48 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} 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}
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=1306424&r1=1306423&r2=1306424&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:48 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} 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}
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=1306424&r1=1306423&r2=1306424&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:48 2012
@@ -218,7 +218,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} if the encoded <code>String</code>s are equal;
-     *          <code>false</code> otherwise.
+     *          {@code false} otherwise.
      * @see #isDoubleMetaphoneEqual(String,String,boolean)
      */
     public boolean isDoubleMetaphoneEqual(String value1, String value2) {
@@ -233,7 +233,7 @@ public class DoubleMetaphone implements 
      * @param value2 The right-hand side of the encoded {@link String#equals(Object)}.
      * @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.
+     *          {@code false} otherwise.
      */
     public boolean isDoubleMetaphoneEqual(String value1, 
                                           String value2, 

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=1306424&r1=1306423&r2=1306424&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:48 2012
@@ -386,7 +386,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} if the metaphones of these strings are identical, 
-     *        <code>false</code> otherwise.
+     *        {@code false} otherwise.
      */
     public boolean isMetaphoneEqual(String str1, String str2) {
         return metaphone(str1).equals(metaphone(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=1306424&r1=1306423&r2=1306424&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:48 2012
@@ -95,7 +95,7 @@ public class Nysiis implements StringEnc
      * 
      * @param c
      *            the character to test
-     * @return {@code true} if the character is a vowel, <code>false</code> otherwise
+     * @return {@code true} if the character is a vowel, {@code false} otherwise
      */
     private static boolean isVowel(final char c) {
         return c == 'A' || c == 'E' || c == 'I' || c == 'O' || c == 'U';
@@ -183,7 +183,7 @@ public class Nysiis implements StringEnc
      *
      * <ul>
      *  <li>{@code true}: encoded strings have a maximum length of 6</li>
-     *  <li><code>false</code>: encoded strings may have arbitrary length</li>
+     *  <li>{@code false}: encoded strings may have arbitrary length</li>
      * </ul>
      *
      * @param strict
@@ -229,7 +229,7 @@ public class Nysiis implements StringEnc
     /**
      * Indicates the strict mode for this {@link Nysiis} encoder.
      *
-     * @return {@code true} 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} 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=1306424&r1=1306423&r2=1306424&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:48 2012
@@ -341,7 +341,7 @@ public class QCodec extends RFC1522Codec
     /**
      * Tests if optional transformation of SPACE characters is to be used
      * 
-     * @return {@code true} if SPACE characters are to be transformed, <code>false</code>
otherwise
+     * @return {@code true} if SPACE characters are to be transformed, {@code false} 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} if SPACE characters are to be transformed, <code>false</code>
otherwise
+     *                  {@code true} if SPACE characters are to be transformed, {@code false}
otherwise
      */
     public void setEncodeBlanks(boolean b) {
         this.encodeBlanks = b;



Mime
View raw message