(mina-sshd) 01/12: Javadoc

[gg...@apache.org]

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/mina-sshd.git

commit d8b97f1be6dec8bf2de7f0c3a2175a1982b74d9d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu May 30 10:48:44 2024 -0400

    Javadoc
---
 .../org/apache/sshd/common/kex/KeyEncapsulationMethod.java     | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/sshd-core/src/main/java/org/apache/sshd/common/kex/KeyEncapsulationMethod.java b/sshd-core/src/main/java/org/apache/sshd/common/kex/KeyEncapsulationMethod.java
index a83612738..84ffe06b7 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/kex/KeyEncapsulationMethod.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/kex/KeyEncapsulationMethod.java
@@ -34,7 +34,9 @@ public interface KeyEncapsulationMethod {
         void init();
 
         /**
-         * Retrieves the KEM public key.
+         * Gets the KEM public key.
+         *
+         * @return the KEM public key.
          */
         byte[] getPublicKey();
 
@@ -42,16 +44,16 @@ public interface KeyEncapsulationMethod {
          * Extracts the secret from an encapsulation ciphertext.
          *
          * @param  encapsulated             ciphertext to process.
-         *
+         * @return the secret from an encapsulation ciphertext.
          * @throws IllegalArgumentException if {@code encapsulated} doesn't have the expected length
          * @throws NullPointerException     if {@code encapsulated == null}
          */
         byte[] extractSecret(byte[] encapsulated);
 
         /**
-         * Retrieves the required encapsulation length in bytes.
+         * Gets the required encapsulation length in bytes.
          *
-         * @return the length required for a valid encapsulation ciphertext
+         * @return the length required for a valid encapsulation ciphertext.
          */
         int getEncapsulationLength();
     }