Skip to content

Commit 0286b36

Browse files
committed
fix doxygen warnings (as mentioned in #228)
[skip ci]
1 parent 65dc00e commit 0286b36

18 files changed

Lines changed: 24 additions & 27 deletions

src/encauth/chachapoly/chacha20poly1305_setiv.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
Set IV + counter data to the ChaCha20Poly1305 state and reset the context
1616
@param st The ChaCha20Poly1305 state
1717
@param iv The IV data to add
18-
@param inlen The length of the IV (must be 12 or 8)
18+
@param ivlen The length of the IV (must be 12 or 8)
1919
@return CRYPT_OK on success
2020
*/
2121
int chacha20poly1305_setiv(chacha20poly1305_state *st, const unsigned char *iv, unsigned long ivlen)

src/encauth/chachapoly/chacha20poly1305_setiv_rfc7905.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
Set IV + counter data (with RFC7905-magic) to the ChaCha20Poly1305 state and reset the context
1616
@param st The ChaCha20Poly1305 state
1717
@param iv The IV data to add
18-
@param inlen The length of the IV (must be 12 or 8)
18+
@param ivlen The length of the IV (must be 12 or 8)
1919
@param sequence_number 64bit sequence number which is incorporated into IV as described in RFC7905
2020
@return CRYPT_OK on success
2121
*/

src/encauth/ocb3/ocb3_init.c

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,6 @@
1515

1616
#ifdef LTC_OCB3_MODE
1717

18-
/**
19-
Sets 'ocb->Offset_current' to 'Offset_0' value (internal function)
20-
@param ocb The OCB state
21-
@param nonce The session nonce
22-
@param noncelen The length of the session nonce (octets)
23-
*/
2418
static void _ocb3_int_calc_offset_zero(ocb3_state *ocb, const unsigned char *nonce, unsigned long noncelen, unsigned long taglen)
2519
{
2620
int x, y, bottom;
@@ -87,7 +81,8 @@ static const struct {
8781
@param key The secret key
8882
@param keylen The length of the secret key (octets)
8983
@param nonce The session nonce
90-
@param noncelen The length of the session nonce (octets)
84+
@param noncelen The length of the session nonce (octets, up to 15)
85+
@param taglen The length of the tag (octets, up to 16)
9186
@return CRYPT_OK if successful
9287
*/
9388
int ocb3_init(ocb3_state *ocb, int cipher,

src/mac/blake2/blake2bmac.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
/**
1515
Initialize an BLAKE2B MAC context.
1616
@param st The BLAKE2B MAC state
17+
@param outlen The size of the MAC output (octets)
1718
@param key The secret key
1819
@param keylen The length of the secret key (octets)
1920
@return CRYPT_OK if successful

src/mac/blake2/blake2bmac_memory_multi.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
BLAKE2B MAC multiple blocks of memory to produce the authentication tag
1717
@param key The secret key
1818
@param keylen The length of the secret key (octets)
19-
@param out [out] Destination of the authentication tag
20-
@param outlen [in/out] Max size and resulting size of authentication tag
19+
@param mac [out] Destination of the authentication tag
20+
@param maclen [in/out] Max size and resulting size of authentication tag
2121
@param in The data to BLAKE2B MAC
2222
@param inlen The length of the data to BLAKE2B MAC (octets)
2323
@param ... tuples of (data,len) pairs to BLAKE2B MAC, terminated with a (NULL,x) (x=don't care)

src/mac/blake2/blake2smac.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
/**
1515
Initialize an BLAKE2S MAC context.
1616
@param st The BLAKE2S MAC state
17+
@param outlen The size of the MAC output (octets)
1718
@param key The secret key
1819
@param keylen The length of the secret key (octets)
1920
@return CRYPT_OK if successful

src/mac/blake2/blake2smac_memory_multi.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
BLAKE2S MAC multiple blocks of memory to produce the authentication tag
1717
@param key The secret key
1818
@param keylen The length of the secret key (octets)
19-
@param out [out] Destination of the authentication tag
20-
@param outlen [in/out] Max size and resulting size of authentication tag
19+
@param mac [out] Destination of the authentication tag
20+
@param maclen [in/out] Max size and resulting size of authentication tag
2121
@param in The data to BLAKE2S MAC
2222
@param inlen The length of the data to BLAKE2S MAC (octets)
2323
@param ... tuples of (data,len) pairs to BLAKE2S MAC, terminated with a (NULL,x) (x=don't care)

src/mac/poly1305/poly1305.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,8 @@ int poly1305_process(poly1305_state *st, const unsigned char *in, unsigned long
164164
/**
165165
Terminate a POLY1305 session
166166
@param st The POLY1305 state
167-
@param out [out] The destination of the POLY1305 authentication tag
168-
@param outlen [in/out] The max size and resulting size of the POLY1305 authentication tag
167+
@param mac [out] The destination of the POLY1305 authentication tag
168+
@param maclen [in/out] The max size and resulting size of the POLY1305 authentication tag
169169
@return CRYPT_OK if successful
170170
*/
171171
int poly1305_done(poly1305_state *st, unsigned char *mac, unsigned long *maclen)

src/mac/poly1305/poly1305_memory_multi.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
POLY1305 multiple blocks of memory to produce the authentication tag
2222
@param key The secret key
2323
@param keylen The length of the secret key (octets)
24-
@param out [out] Destination of the authentication tag
25-
@param outlen [in/out] Max size and resulting size of authentication tag
24+
@param mac [out] Destination of the authentication tag
25+
@param maclen [in/out] Max size and resulting size of authentication tag
2626
@param in The data to POLY1305
2727
@param inlen The length of the data to POLY1305 (octets)
2828
@param ... tuples of (data,len) pairs to POLY1305, terminated with a (NULL,x) (x=don't care)

src/math/tfm_desc.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ static int tfm_ecc_projective_dbl_point(ecc_point *P, ecc_point *R, void *modulu
538538
@param Q The point to add
539539
@param R [out] The destination of the double
540540
@param modulus The modulus of the field the ECC curve is in
541-
@param mp The "b" value from montgomery_setup()
541+
@param Mp The "b" value from montgomery_setup()
542542
@return CRYPT_OK on success
543543
*/
544544
static int tfm_ecc_projective_add_point(ecc_point *P, ecc_point *Q, ecc_point *R, void *modulus, void *Mp)

0 commit comments

Comments
 (0)