Fixed comments

terl · Jul 31, 2021 · e24bfc5 · e24bfc5
1 parent e1fdbee
commit e24bfc5
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/src/main/java/com/goterl/lazysodium/interfaces/SecretStream.java b/src/main/java/com/goterl/lazysodium/interfaces/SecretStream.java
@@ -75,7 +75,7 @@ boolean cryptoSecretStreamInitPush(
 
         /**
          * Encrypt a {@code message}.
-         * @param state State as initialised in {@link #cryptoSecretStreamInitPush(State, byte[], byte[])}}.
+         * @param state State as initialised in cryptoSecretStreamInitPush.
          * @param cipher The resulting cipher of size {@link #ABYTES} + {@code messageLen}.
          * @param cipherAddr The cipher address will be stored here if not null.
          * @param message The message to encrypt.
@@ -119,7 +119,7 @@ boolean cryptoSecretStreamPush(
         /**
          * Encrypt a {@code message}. This is like cryptoSecretStreamPush
          * but without additional data or an address to store the cipher.
-         * @param state State as initialised in {@link #cryptoSecretStreamInitPush(State, byte[], byte[])}}.
+         * @param state State as initialised in cryptoSecretStreamInitPush.
          * @param cipher The resulting cipher of size {@link #ABYTES} + {@code messageLen}.
          * @param message The message to encrypt.
          * @param messageLen The message length.
@@ -151,7 +151,7 @@ boolean cryptoSecretStreamInitPull(
 
         /**
          * Decrypt a message.
-         * @param state The state as put into {@link #cryptoSecretStreamInitPull(State, byte[], byte[])}.
+         * @param state The state as put into cryptoSecretStreamInitPull.
          * @param message The message of size {@code cipherLen} - {@link #ABYTES}.
          * @param messageAddress The place to store the message.
          * @param tag The tag.
@@ -174,7 +174,7 @@ boolean cryptoSecretStreamPull(
 
         /**
          * Decrypt a message without additional data.
-         * @param state The state as put into {@link #cryptoSecretStreamInitPull(State, byte[], byte[])}.
+         * @param state The state as put into cryptoSecretStreamInitPull.
          * @param message The message of size {@code cipherLen} - {@link #ABYTES}.
          * @param tag The tag.
          * @param cipher The resulting encrypted message.

diff --git a/src/main/java/com/goterl/lazysodium/utils/LibraryLoader.java b/src/main/java/com/goterl/lazysodium/utils/LibraryLoader.java
@@ -136,6 +136,7 @@ private void loadBundledLibrary() {
 
     /**
      * Returns the absolute path to sodium library inside JAR (beginning with '/'), e.g. /linux/libsodium.so.
+     * @return The path to the libsodium binary.
      */
     public static String getSodiumPathInResources() {
         boolean is64Bit = Native.POINTER_SIZE == 8;