From 947b485e76f6a086e2c57ea606ed04ebe6e266f8 Mon Sep 17 00:00:00 2001 From: Patrick Canterino Date: Wed, 3 Apr 2024 14:36:16 +0200 Subject: [PATCH 1/1] Fixed function comments --- lib/functions.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/functions.php b/lib/functions.php index a92509b..3883173 100644 --- a/lib/functions.php +++ b/lib/functions.php @@ -1216,7 +1216,7 @@ function jirafeau_crypt_create_iv($base, $size) * Crypt file using Sodium and returns decrypt key. * @param $fp_src file path to the file to crypt. * @param $fp_dst file path to the file to write crypted file (must not be the same). - * @return decrypt key composed of the key and the iv separated by a point ('.') + * @return key used to encrypt the file */ function jirafeau_encrypt_file($fp_src, $fp_dst) { @@ -1256,8 +1256,8 @@ function jirafeau_encrypt_file($fp_src, $fp_dst) * Decrypt file using Sodium. * @param $fp_src file path to the file to decrypt. * @param $fp_dst file path to the file to write decrypted file (must not be the same). - * @param $k string composed of the key and the iv separated by a point ('.') - * @return key used to decrypt. a string of length 0 is returned if failed. + * @param $k decryption key + * @return true if decryption succeeded, false otherwise */ function jirafeau_decrypt_file($fp_src, $fp_dst, $k) { @@ -1300,7 +1300,7 @@ function jirafeau_decrypt_file($fp_src, $fp_dst, $k) * @param $fp_src file path to the file to decrypt. * @param $fp_dst file path to the file to write decrypted file (could be the same). * @param $k string composed of the key and the iv separated by a point ('.') - * @return key used to decrypt. a string of length 0 is returned if failed. + * @return true if decryption succeeded, false otherwise */ function jirafeau_decrypt_file_legacy($fp_src, $fp_dst, $k) { -- 2.34.1