summaryrefslogtreecommitdiff
path: root/libavutil
diff options
context:
space:
mode:
authorMarvin Scholz <epirat07@gmail.com>2022-09-25 01:09:22 +0200
committerAnton Khirnov <anton@khirnov.net>2022-10-17 09:56:47 +0200
commit96f89cdc87e20ee6ae65865efdd9cd495eb82505 (patch)
tree81065ee74331f1daefcc595cdee6ed1efb395313 /libavutil
parent023966d2f845b7887335adeab1dbafcfdfe12125 (diff)
avutil/des: Add doxy for missing arguments
Additionally reorder so that the arguments list matches the order of the arguments in the function declaration.
Diffstat (limited to 'libavutil')
-rw-r--r--libavutil/des.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/libavutil/des.h b/libavutil/des.h
index 4cf11f5bca..3a3e6fa47c 100644
--- a/libavutil/des.h
+++ b/libavutil/des.h
@@ -43,6 +43,8 @@ AVDES *av_des_alloc(void);
/**
* @brief Initializes an AVDES context.
*
+ * @param d pointer to a AVDES structure to initialize
+ * @param key pointer to the key to use
* @param key_bits must be 64 or 192
* @param decrypt 0 for encryption/CBC-MAC, 1 for decryption
* @return zero on success, negative value otherwise
@@ -52,9 +54,10 @@ int av_des_init(struct AVDES *d, const uint8_t *key, int key_bits, int decrypt);
/**
* @brief Encrypts / decrypts using the DES algorithm.
*
- * @param count number of 8 byte blocks
+ * @param d pointer to the AVDES structure
* @param dst destination array, can be equal to src, must be 8-byte aligned
* @param src source array, can be equal to dst, must be 8-byte aligned, may be NULL
+ * @param count number of 8 byte blocks
* @param iv initialization vector for CBC mode, if NULL then ECB will be used,
* must be 8-byte aligned
* @param decrypt 0 for encryption, 1 for decryption
@@ -64,9 +67,10 @@ void av_des_crypt(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count,
/**
* @brief Calculates CBC-MAC using the DES algorithm.
*
- * @param count number of 8 byte blocks
+ * @param d pointer to the AVDES structure
* @param dst destination array, can be equal to src, must be 8-byte aligned
* @param src source array, can be equal to dst, must be 8-byte aligned, may be NULL
+ * @param count number of 8 byte blocks
*/
void av_des_mac(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count);