From 0542ffa2db75fc6affd1b5c83bcb5af8e7d92c88 Mon Sep 17 00:00:00 2001 From: Diadlo Date: Sat, 2 Sep 2017 12:08:15 +0300 Subject: Adjust docs of few toxencrypt function to the code Add correct information about behaviour if input pointer is NULL Fix #590 --- toxencryptsave/toxencryptsave.api.h | 4 +++- toxencryptsave/toxencryptsave.h | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) (limited to 'toxencryptsave') diff --git a/toxencryptsave/toxencryptsave.api.h b/toxencryptsave/toxencryptsave.api.h index 1844edf8..61f685f8 100644 --- a/toxencryptsave/toxencryptsave.api.h +++ b/toxencryptsave/toxencryptsave.api.h @@ -283,6 +283,8 @@ class pass_Key { * If the passed byte arrays are smaller than required, the behaviour is * undefined. * + * If the cipher text pointer or the salt is NULL, this function returns false. + * * Success does not say anything about the validity of the data, only that * data of the appropriate size was copied. * @@ -307,7 +309,7 @@ static bool get_salt(const uint8_t *ciphertext, uint8_t[PASS_SALT_LENGTH] salt) * If the passed byte array is smaller than required, the behaviour is * undefined. * - * If the cipher text pointer is NULL, this function returns false. + * If the data pointer is NULL, the behaviour is undefined * * @return true if the data is encrypted by this module. */ diff --git a/toxencryptsave/toxencryptsave.h b/toxencryptsave/toxencryptsave.h index d13ebbc6..ef1ab152 100644 --- a/toxencryptsave/toxencryptsave.h +++ b/toxencryptsave/toxencryptsave.h @@ -355,6 +355,8 @@ typedef enum TOX_ERR_GET_SALT { * If the passed byte arrays are smaller than required, the behaviour is * undefined. * + * If the cipher text pointer or the salt is NULL, this function returns false. + * * Success does not say anything about the validity of the data, only that * data of the appropriate size was copied. * @@ -372,7 +374,7 @@ bool tox_get_salt(const uint8_t *ciphertext, uint8_t *salt, TOX_ERR_GET_SALT *er * If the passed byte array is smaller than required, the behaviour is * undefined. * - * If the cipher text pointer is NULL, this function returns false. + * If the data pointer is NULL, the behaviour is undefined * * @return true if the data is encrypted by this module. */ -- cgit v1.2.3