You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/04/28 19:10:22 UTC
[commons-net] branch master updated: Javadoc: Use {@code } instead of HTML tags.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git
The following commit(s) were added to refs/heads/master by this push:
new 1c639134 Javadoc: Use {@code } instead of HTML tags.
1c639134 is described below
commit 1c6391341c3fd65fd751953991756b263b31d115
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Apr 28 15:10:17 2023 -0400
Javadoc: Use {@code } instead of HTML tags.
---
.../java/org/apache/commons/net/ftp/FTPClient.java | 2 +-
.../commons/net/ftp/parser/OS400FTPEntryParser.java | 2 +-
.../java/org/apache/commons/net/ntp/NtpV3Impl.java | 4 ++--
src/main/java/org/apache/commons/net/ntp/TimeInfo.java | 4 ++--
.../java/org/apache/commons/net/ntp/TimeStamp.java | 4 ++--
src/main/java/org/apache/commons/net/util/Base64.java | 18 +++++++++---------
.../java/org/apache/commons/net/util/SubnetUtils.java | 2 +-
7 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClient.java b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
index 700d9bbb..e8ff80ef 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -2144,7 +2144,7 @@ public class FTPClient extends FTP implements Configurable {
}
/**
- * Whether to attempt using EPSV with IPv4. Default (if not set) is <code>false</code>
+ * Whether to attempt using EPSV with IPv4. Default (if not set) is {@code false}
*
* @return true if EPSV shall be attempted with IPv4.
* @since 2.2
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
index 5f9a3287..7320886e 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
@@ -276,7 +276,7 @@ public class OS400FTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
/**
*
* @param string String value that is checked for <code>null</code> or empty.
- * @return <code>true</code> for <code>null</code> or empty values, else <code>false</code>.
+ * @return {@code true} for <code>null</code> or empty values, else {@code false}.
*/
private boolean isNullOrEmpty(final String string) {
return string == null || string.isEmpty();
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
index 145b9a2c..a487e5d2 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
@@ -80,11 +80,11 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Compares this object against the specified object. The result is <code>true</code> if and only if the argument is not <code>null</code> and is a
+ * Compares this object against the specified object. The result is {@code true} if and only if the argument is not <code>null</code> and is a
* <code>NtpV3Impl</code> object that contains the same values as this object.
*
* @param obj the object to compare with.
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
* @since 3.4
*/
@Override
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
index 71d1e4fb..f0a328d7 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
@@ -211,11 +211,11 @@ public class TimeInfo {
}
/**
- * Compares this object against the specified object. The result is <code>true</code> if and only if the argument is not <code>null</code> and is a
+ * Compares this object against the specified object. The result is {@code true} if and only if the argument is not <code>null</code> and is a
* <code>TimeStamp</code> object that contains the same values as this object.
*
* @param obj the object to compare with.
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
* @since 3.4
*/
@Override
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
index eb1c7426..c77558ee 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -264,11 +264,11 @@ public class TimeStamp implements Serializable, Comparable<TimeStamp> {
}
/**
- * Compares this object against the specified object. The result is <code>true</code> if and only if the argument is not <code>null</code> and is a
+ * Compares this object against the specified object. The result is {@code true} if and only if the argument is not <code>null</code> and is a
* <code>Long</code> object that contains the same <code>long</code> value as this object.
*
* @param obj the object to compare with.
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
*/
@Override
public boolean equals(final Object obj) {
diff --git a/src/main/java/org/apache/commons/net/util/Base64.java b/src/main/java/org/apache/commons/net/util/Base64.java
index e8cee0c2..5ecba943 100644
--- a/src/main/java/org/apache/commons/net/util/Base64.java
+++ b/src/main/java/org/apache/commons/net/util/Base64.java
@@ -117,7 +117,7 @@ public class Base64 {
* Tests a given byte array to see if it contains only valid characters within the Base64 alphabet.
*
* @param arrayOctet byte array to test
- * @return <code>true</code> if any byte is a valid character in the Base64 alphabet; false herwise
+ * @return {@code true} if any byte is a valid character in the Base64 alphabet; false herwise
*/
private static boolean containsBase64Byte(final byte[] arrayOctet) {
for (final byte element : arrayOctet) {
@@ -175,7 +175,7 @@ public class Base64 {
* Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
*
* @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
+ * @param isChunked 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}
*/
@@ -187,8 +187,8 @@ public class Base64 {
* Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
*
* @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
- * @param urlSafe if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters.
+ * @param isChunked if {@code true} this encoder will chunk the base64 output into 76 character blocks
+ * @param urlSafe 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}
* @since 1.4
@@ -201,8 +201,8 @@ public class Base64 {
* Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
*
* @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
- * @param urlSafe if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters.
+ * @param isChunked if {@code true} this encoder will chunk the base64 output into 76 character blocks
+ * @param urlSafe 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.
* @throws IllegalArgumentException Thrown when the input array needs an output array bigger than maxResultSize
@@ -339,7 +339,7 @@ public class Base64 {
* Tests a given byte array to see if it contains only valid characters within the Base64 alphabet. Currently, the method treats whitespace as valid.
*
* @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; false, otherwise
+ * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty; false, otherwise
*/
public static boolean isArrayByteBase64(final byte[] arrayOctet) {
for (final byte element : arrayOctet) {
@@ -354,7 +354,7 @@ public class Base64 {
* Returns whether or not the <code>octet</code> is in the base 64 alphabet.
*
* @param octet The value to test
- * @return <code>true</code> if the value is defined in the base 64 alphabet, <code>false</code> otherwise.
+ * @return {@code true} if the value is defined in the base 64 alphabet, {@code false} otherwise.
* @since 1.4
*/
public static boolean isBase64(final byte octet) {
@@ -503,7 +503,7 @@ public class Base64 {
* When decoding all variants are supported.
* </p>
*
- * @param urlSafe if <code>true</code>, URL-safe encoding is used. In most cases this should be set to <code>false</code>.
+ * @param urlSafe if {@code true}, URL-safe encoding is used. In most cases this should be set to {@code false}.
* @since 1.4
*/
public Base64(final boolean urlSafe) {
diff --git a/src/main/java/org/apache/commons/net/util/SubnetUtils.java b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
index e93b75e0..5655c957 100644
--- a/src/main/java/org/apache/commons/net/util/SubnetUtils.java
+++ b/src/main/java/org/apache/commons/net/util/SubnetUtils.java
@@ -362,7 +362,7 @@ public class SubnetUtils {
}
/**
- * Sets to <code>true</code> if you want the return value of {@link SubnetInfo#getAddressCount()} to include the network and broadcast addresses. This also
+ * Sets to {@code true} if you want the return value of {@link SubnetInfo#getAddressCount()} to include the network and broadcast addresses. This also
* applies to {@link SubnetInfo#isInRange(int)}
*
* @param inclusiveHostCount true if network and broadcast addresses are to be included