(commons-net) branch master updated: Javadoc

[ggregory]

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 2208f032 Javadoc
2208f032 is described below

commit 2208f032a14dcbbf8f5fd9cd8495b282aaeb5b9f
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jun 16 11:16:43 2024 -0400

    Javadoc
---
 src/main/java/org/apache/commons/net/util/SSLSocketUtils.java | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/net/util/SSLSocketUtils.java 
b/src/main/java/org/apache/commons/net/util/SSLSocketUtils.java
index b37161d6..e2560153 100644
--- a/src/main/java/org/apache/commons/net/util/SSLSocketUtils.java
+++ b/src/main/java/org/apache/commons/net/util/SSLSocketUtils.java
@@ -31,8 +31,9 @@ public class SSLSocketUtils {
      * Enable the HTTPS endpoint identification algorithm on an SSLSocket.
      *
      * @param socket the SSL socket
-     * @return {@code true} on success
+     * @return Always returns {@code true}
      */
+    // TODO for 4.0: becomes a void method.
     public static boolean enableEndpointNameVerification(final SSLSocket 
socket) {
         final SSLParameters sslParameters = socket.getSSLParameters();
         sslParameters.setEndpointIdentificationAlgorithm("HTTPS");