Skip to content

Commit b0083b6

Browse files
committed
Replace "<code>false</code>" with "{@code false}"
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1306424 13f79535-47bb-0310-9956-ffa450edef68
1 parent e23e8e1 commit b0083b6

10 files changed

Lines changed: 22 additions & 22 deletions

File tree

src/main/java/org/apache/commons/codec/binary/Base32.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ void encode(byte[] in, int inPos, int inAvail) { // package protected for access
464464
*
465465
* @param octet
466466
* The value to test
467-
* @return {@code true} if the value is defined in the the Base32 alphabet <code>false</code> otherwise.
467+
* @return {@code true} if the value is defined in the the Base32 alphabet {@code false} otherwise.
468468
*/
469469
@Override
470470
public boolean isInAlphabet(byte octet) {

src/main/java/org/apache/commons/codec/binary/Base64.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ public Base64() {
188188
*
189189
* @param urlSafe
190190
* if {@code true}, URL-safe encoding is used. In most cases this should be set to
191-
* <code>false</code>.
191+
* {@code false}.
192192
* @since 1.4
193193
*/
194194
public Base64(boolean urlSafe) {
@@ -474,7 +474,7 @@ void decode(byte[] in, int inPos, int inAvail) {
474474
* @param arrayOctet
475475
* byte array to test
476476
* @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
477-
* <code>false</code>, otherwise
477+
* {@code false}, otherwise
478478
* @deprecated 1.5 Use {@link #isBase64(byte[])}, will be removed in 2.0.
479479
*/
480480
public static boolean isArrayByteBase64(byte[] arrayOctet) {
@@ -486,7 +486,7 @@ public static boolean isArrayByteBase64(byte[] arrayOctet) {
486486
*
487487
* @param octet
488488
* The value to test
489-
* @return {@code true} if the value is defined in the the base 64 alphabet, <code>false</code> otherwise.
489+
* @return {@code true} if the value is defined in the the base 64 alphabet, {@code false} otherwise.
490490
* @since 1.4
491491
*/
492492
public static boolean isBase64(byte octet) {
@@ -500,7 +500,7 @@ public static boolean isBase64(byte octet) {
500500
* @param base64
501501
* String to test
502502
* @return {@code true} if all characters in the String are valid characters in the Base64 alphabet or if
503-
* the String is empty; <code>false</code>, otherwise
503+
* the String is empty; {@code false}, otherwise
504504
* @since 1.5
505505
*/
506506
public static boolean isBase64(String base64) {
@@ -514,7 +514,7 @@ public static boolean isBase64(String base64) {
514514
* @param arrayOctet
515515
* byte array to test
516516
* @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
517-
* <code>false</code>, otherwise
517+
* {@code false}, otherwise
518518
* @since 1.5
519519
*/
520520
public static boolean isBase64(byte[] arrayOctet) {
@@ -748,7 +748,7 @@ static byte[] toIntegerBytes(BigInteger bigInt) {
748748
*
749749
* @param octet
750750
* The value to test
751-
* @return {@code true} if the value is defined in the the Base32 alphabet <code>false</code> otherwise.
751+
* @return {@code true} if the value is defined in the the Base32 alphabet {@code false} otherwise.
752752
*/
753753
@Override
754754
protected boolean isInAlphabet(byte octet) {

src/main/java/org/apache/commons/codec/binary/BaseNCodec.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ public String encodeAsString(byte[] pArray){
372372
*
373373
* @param value The value to test
374374
*
375-
* @return {@code true} if the value is defined in the current alphabet, <code>false</code> otherwise.
375+
* @return {@code true} if the value is defined in the current alphabet, {@code false} otherwise.
376376
*/
377377
protected abstract boolean isInAlphabet(byte value);
378378

@@ -384,7 +384,7 @@ public String encodeAsString(byte[] pArray){
384384
* @param allowWSPad if {@code true}, then whitespace and PAD are also allowed
385385
*
386386
* @return {@code true} if all bytes are valid characters in the alphabet or if the byte array is empty;
387-
* <code>false</code>, otherwise
387+
* {@code false}, otherwise
388388
*/
389389
public boolean isInAlphabet(byte[] arrayOctet, boolean allowWSPad) {
390390
for (int i = 0; i < arrayOctet.length; i++) {
@@ -402,7 +402,7 @@ public boolean isInAlphabet(byte[] arrayOctet, boolean allowWSPad) {
402402
*
403403
* @param basen String to test
404404
* @return {@code true} if all characters in the String are valid characters in the alphabet or if
405-
* the String is empty; <code>false</code>, otherwise
405+
* the String is empty; {@code false}, otherwise
406406
* @see #isInAlphabet(byte[], boolean)
407407
*/
408408
public boolean isInAlphabet(String basen) {
@@ -416,7 +416,7 @@ public boolean isInAlphabet(String basen) {
416416
*
417417
* @param arrayOctet
418418
* byte array to test
419-
* @return {@code true} if any byte is a valid character in the alphabet or PAD; <code>false</code> otherwise
419+
* @return {@code true} if any byte is a valid character in the alphabet or PAD; {@code false} otherwise
420420
*/
421421
protected boolean containsAlphabetOrPad(byte[] arrayOctet) {
422422
if (arrayOctet == null) {

src/main/java/org/apache/commons/codec/binary/Hex.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public static char[] encodeHex(byte[] data) {
115115
* @param data
116116
* a byte[] to convert to Hex characters
117117
* @param toLowerCase
118-
* {@code true} converts to lowercase, <code>false</code> to uppercase
118+
* {@code true} converts to lowercase, {@code false} to uppercase
119119
* @return A char[] containing hexadecimal characters
120120
* @since 1.4
121121
*/

src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public Object encode(Object source) throws EncoderException {
6767
* First of two strings to compare
6868
* @param str2
6969
* Second of two strings to compare
70-
* @return {@code true} if the encodings of these strings are identical, <code>false</code> otherwise.
70+
* @return {@code true} if the encodings of these strings are identical, {@code false} otherwise.
7171
* @throws EncoderException
7272
*/
7373
public boolean isEncodeEqual(String str1, String str2) throws EncoderException {

src/main/java/org/apache/commons/codec/language/Caverphone.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public String encode(String pString) {
9494
* First of two strings to compare
9595
* @param str2
9696
* Second of two strings to compare
97-
* @return {@code true} if the caverphones of these strings are identical, <code>false</code> otherwise.
97+
* @return {@code true} if the caverphones of these strings are identical, {@code false} otherwise.
9898
*/
9999
public boolean isCaverphoneEqual(String str1, String str2) {
100100
return this.caverphone(str1).equals(this.caverphone(str2));

src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ public String encode(String value) {
218218
* @param value1 The left-hand side of the encoded {@link String#equals(Object)}.
219219
* @param value2 The right-hand side of the encoded {@link String#equals(Object)}.
220220
* @return {@code true} if the encoded <code>String</code>s are equal;
221-
* <code>false</code> otherwise.
221+
* {@code false} otherwise.
222222
* @see #isDoubleMetaphoneEqual(String,String,boolean)
223223
*/
224224
public boolean isDoubleMetaphoneEqual(String value1, String value2) {
@@ -233,7 +233,7 @@ public boolean isDoubleMetaphoneEqual(String value1, String value2) {
233233
* @param value2 The right-hand side of the encoded {@link String#equals(Object)}.
234234
* @param alternate use the alternate value if {@code true}.
235235
* @return {@code true} if the encoded <code>String</code>s are equal;
236-
* <code>false</code> otherwise.
236+
* {@code false} otherwise.
237237
*/
238238
public boolean isDoubleMetaphoneEqual(String value1,
239239
String value2,

src/main/java/org/apache/commons/codec/language/Metaphone.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ public String encode(String pString) {
386386
* @param str1 First of two strings to compare
387387
* @param str2 Second of two strings to compare
388388
* @return {@code true} if the metaphones of these strings are identical,
389-
* <code>false</code> otherwise.
389+
* {@code false} otherwise.
390390
*/
391391
public boolean isMetaphoneEqual(String str1, String str2) {
392392
return metaphone(str1).equals(metaphone(str2));

src/main/java/org/apache/commons/codec/language/Nysiis.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ public class Nysiis implements StringEncoder {
9595
*
9696
* @param c
9797
* the character to test
98-
* @return {@code true} if the character is a vowel, <code>false</code> otherwise
98+
* @return {@code true} if the character is a vowel, {@code false} otherwise
9999
*/
100100
private static boolean isVowel(final char c) {
101101
return c == 'A' || c == 'E' || c == 'I' || c == 'O' || c == 'U';
@@ -183,7 +183,7 @@ public Nysiis() {
183183
*
184184
* <ul>
185185
* <li>{@code true}: encoded strings have a maximum length of 6</li>
186-
* <li><code>false</code>: encoded strings may have arbitrary length</li>
186+
* <li>{@code false}: encoded strings may have arbitrary length</li>
187187
* </ul>
188188
*
189189
* @param strict
@@ -229,7 +229,7 @@ public String encode(String pString) {
229229
/**
230230
* Indicates the strict mode for this {@link Nysiis} encoder.
231231
*
232-
* @return {@code true} if the encoder is configured for strict mode, <code>false</code> otherwise
232+
* @return {@code true} if the encoder is configured for strict mode, {@code false} otherwise
233233
*/
234234
public boolean isStrict() {
235235
return this.strict;

src/main/java/org/apache/commons/codec/net/QCodec.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ public String getDefaultCharset() {
341341
/**
342342
* Tests if optional transformation of SPACE characters is to be used
343343
*
344-
* @return {@code true} if SPACE characters are to be transformed, <code>false</code> otherwise
344+
* @return {@code true} if SPACE characters are to be transformed, {@code false} otherwise
345345
*/
346346
public boolean isEncodeBlanks() {
347347
return this.encodeBlanks;
@@ -351,7 +351,7 @@ public boolean isEncodeBlanks() {
351351
* Defines whether optional transformation of SPACE characters is to be used
352352
*
353353
* @param b
354-
* {@code true} if SPACE characters are to be transformed, <code>false</code> otherwise
354+
* {@code true} if SPACE characters are to be transformed, {@code false} otherwise
355355
*/
356356
public void setEncodeBlanks(boolean b) {
357357
this.encodeBlanks = b;

0 commit comments

Comments
 (0)