Note that I try to always make the @since tag the last one. YMMV.

Gary

On Tue, Feb 13, 2024 at 6:55 AM <s...@apache.org> wrote:
>
> This is an automated email from the ASF dual-hosted git repository.
>
> sebb 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 2d557a20 Add Javadoc @return comments
> 2d557a20 is described below
>
> commit 2d557a2089ae40b00fa29f46b7bbe9d775f55ea8
> Author: Sebb <s...@apache.org>
> AuthorDate: Tue Feb 13 11:55:24 2024 +0000
>
>     Add Javadoc @return comments
> ---
>  src/main/java/org/apache/commons/net/ftp/FTPSClient.java | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java 
> b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
> index 8c19c320..70b08397 100644
> --- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
> +++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
> @@ -716,6 +716,7 @@ public class FTPSClient extends FTPClient {
>       * Gets the use client mode flag. The {@link #getUseClientMode()} method 
> gets the value from the socket while
>       * this method gets its value from this instance's config.
>       * @since 3.11.0
> +     * @return True If the socket should start its first handshake in 
> "client" mode.
>       */
>      protected boolean isClientMode() {
>          return isClientMode;
> @@ -724,6 +725,7 @@ public class FTPSClient extends FTPClient {
>      /**
>       * Gets whether a new SSL session may be established by this socket. 
> Default true
>       * @since 3.11.0
> +     * @return True if session may be established
>       */
>      protected boolean isCreation() {
>          return isCreation;
> @@ -744,6 +746,7 @@ public class FTPSClient extends FTPClient {
>      /**
>       * Gets the security mode. (True - Implicit Mode / False - Explicit Mode)
>       * @since 3.11.0
> +     * @return True if enabled, false if not.
>       */
>      protected boolean isImplicit() {
>          return isImplicit;
> @@ -753,6 +756,7 @@ public class FTPSClient extends FTPClient {
>       * Gets the need client auth flag. The {@link #getNeedClientAuth()} 
> method gets the value from the socket while
>       * this method gets its value from this instance's config.
>       * @since 3.11.0
> +     * @return True if enabled, false if not.
>       */
>      protected boolean isNeedClientAuth() {
>          return isNeedClientAuth;
> @@ -762,6 +766,7 @@ public class FTPSClient extends FTPClient {
>       * Gets the want client auth flag. The {@link #getWantClientAuth()} 
> method gets the value from the socket while
>       * this method gets its value from this instance's config.
>       * @since 3.11.0
> +     * @return True if enabled, false if not.
>       */
>      protected boolean isWantClientAuth() {
>          return isWantClientAuth;
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org

Reply via email to