mirror of
https://github.com/irungentoo/toxcore.git
synced 2024-03-22 13:30:51 +08:00
Adjust docs of few toxencrypt function to the code
Add correct information about behaviour if input pointer is NULL Fix #590
This commit is contained in:
parent
c49a6e7f5b
commit
0542ffa2db
|
@ -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.
|
||||
*/
|
||||
|
|
|
@ -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.
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue
Block a user