Merge pull request #264 from libtom/pr/doxygen-warnings

fix doxygen warnings (as mentioned in #228)

src/encauth/chachapoly/chacha20poly1305_setiv.c

@@ -15,7 +15,7 @@
   Set IV + counter data to the ChaCha20Poly1305 state and reset the context
   @param st     The ChaCha20Poly1305 state
   @param iv     The IV data to add
-  @param inlen  The length of the IV (must be 12 or 8)
+  @param ivlen  The length of the IV (must be 12 or 8)
   @return CRYPT_OK on success
  */
 int chacha20poly1305_setiv(chacha20poly1305_state *st, const unsigned char *iv, unsigned long ivlen)

src/encauth/chachapoly/chacha20poly1305_setiv_rfc7905.c

@@ -15,7 +15,7 @@
   Set IV + counter data (with RFC7905-magic) to the ChaCha20Poly1305 state and reset the context
   @param st     The ChaCha20Poly1305 state
   @param iv     The IV data to add
-  @param inlen  The length of the IV (must be 12 or 8)
+  @param ivlen  The length of the IV (must be 12 or 8)
   @param sequence_number   64bit sequence number which is incorporated into IV as described in RFC7905
   @return CRYPT_OK on success
  */

src/encauth/ocb3/ocb3_init.c

@@ -15,12 +15,6 @@
 
 #ifdef LTC_OCB3_MODE
 
-/**
-   Sets 'ocb->Offset_current' to 'Offset_0' value (internal function)
-   @param ocb       The OCB state
-   @param nonce     The session nonce
-   @param noncelen  The length of the session nonce (octets)
-*/
 static void _ocb3_int_calc_offset_zero(ocb3_state *ocb, const unsigned char *nonce, unsigned long noncelen, unsigned long taglen)
 {
    int x, y, bottom;
@@ -87,7 +81,8 @@ static const struct {
    @param key       The secret key
    @param keylen    The length of the secret key (octets)
    @param nonce     The session nonce
-   @param noncelen  The length of the session nonce (octets)
+   @param noncelen  The length of the session nonce (octets, up to 15)
+   @param taglen    The length of the tag (octets, up to 16)
    @return CRYPT_OK if successful
 */
 int ocb3_init(ocb3_state *ocb, int cipher,

src/mac/blake2/blake2bmac.c

@@ -14,6 +14,7 @@
 /**
    Initialize an BLAKE2B MAC context.
    @param st       The BLAKE2B MAC state
+   @param outlen   The size of the MAC output (octets)
    @param key      The secret key
    @param keylen   The length of the secret key (octets)
    @return CRYPT_OK if successful

src/mac/blake2/blake2bmac_memory_multi.c

@@ -16,8 +16,8 @@
    BLAKE2B MAC multiple blocks of memory to produce the authentication tag
    @param key       The secret key
    @param keylen    The length of the secret key (octets)
-   @param out       [out] Destination of the authentication tag
-   @param outlen    [in/out] Max size and resulting size of authentication tag
+   @param mac       [out] Destination of the authentication tag
+   @param maclen    [in/out] Max size and resulting size of authentication tag
    @param in        The data to BLAKE2B MAC
    @param inlen     The length of the data to BLAKE2B MAC (octets)
    @param ...       tuples of (data,len) pairs to BLAKE2B MAC, terminated with a (NULL,x) (x=don't care)

src/mac/blake2/blake2smac.c

@@ -14,6 +14,7 @@
 /**
    Initialize an BLAKE2S MAC context.
    @param st       The BLAKE2S MAC state
+   @param outlen   The size of the MAC output (octets)
    @param key      The secret key
    @param keylen   The length of the secret key (octets)
    @return CRYPT_OK if successful

src/mac/blake2/blake2smac_memory_multi.c

@@ -16,8 +16,8 @@
    BLAKE2S MAC multiple blocks of memory to produce the authentication tag
    @param key       The secret key
    @param keylen    The length of the secret key (octets)
-   @param out       [out] Destination of the authentication tag
-   @param outlen    [in/out] Max size and resulting size of authentication tag
+   @param mac       [out] Destination of the authentication tag
+   @param maclen    [in/out] Max size and resulting size of authentication tag
    @param in        The data to BLAKE2S MAC
    @param inlen     The length of the data to BLAKE2S MAC (octets)
    @param ...       tuples of (data,len) pairs to BLAKE2S MAC, terminated with a (NULL,x) (x=don't care)

src/mac/poly1305/poly1305.c

@@ -164,8 +164,8 @@ int poly1305_process(poly1305_state *st, const unsigned char *in, unsigned long
 /**
    Terminate a POLY1305 session
    @param st      The POLY1305 state
-   @param out     [out] The destination of the POLY1305 authentication tag
-   @param outlen  [in/out]  The max size and resulting size of the POLY1305 authentication tag
+   @param mac     [out] The destination of the POLY1305 authentication tag
+   @param maclen  [in/out]  The max size and resulting size of the POLY1305 authentication tag
    @return CRYPT_OK if successful
 */
 int poly1305_done(poly1305_state *st, unsigned char *mac, unsigned long *maclen)

src/mac/poly1305/poly1305_memory_multi.c

@@ -21,8 +21,8 @@
    POLY1305 multiple blocks of memory to produce the authentication tag
    @param key       The secret key
    @param keylen    The length of the secret key (octets)
-   @param out       [out] Destination of the authentication tag
-   @param outlen    [in/out] Max size and resulting size of authentication tag
+   @param mac       [out] Destination of the authentication tag
+   @param maclen    [in/out] Max size and resulting size of authentication tag
    @param in        The data to POLY1305
    @param inlen     The length of the data to POLY1305 (octets)
    @param ...       tuples of (data,len) pairs to POLY1305, terminated with a (NULL,x) (x=don't care)

src/math/tfm_desc.c

@@ -538,7 +538,7 @@ static int tfm_ecc_projective_dbl_point(ecc_point *P, ecc_point *R, void *modulu
    @param Q        The point to add
    @param R        [out] The destination of the double
    @param modulus  The modulus of the field the ECC curve is in
-   @param mp       The "b" value from montgomery_setup()
+   @param Mp       The "b" value from montgomery_setup()
    @return CRYPT_OK on success
 */
 static int tfm_ecc_projective_add_point(ecc_point *P, ecc_point *Q, ecc_point *R, void *modulus, void *Mp)

src/pk/asn1/der/sequence/der_decode_subject_public_key_info.c

@@ -31,7 +31,7 @@
    @param algorithm             One out of the enum #public_key_algorithms
    @param public_key            The buffer for the public key
    @param public_key_len        [in/out] The length of the public key buffer and the written length
-   @param parameters_type       The parameters' type out of the enum #ltc_asn1_type
+   @param parameters_type       The parameters' type out of the enum ltc_asn1_type
    @param parameters            The parameters to include
    @param parameters_len        The number of parameters to include
    @return CRYPT_OK on success

src/pk/asn1/der/sequence/der_encode_subject_public_key_info.c

@@ -32,7 +32,7 @@
    @param algorithm             One out of the enum #public_key_algorithms
    @param public_key            The buffer for the public key
    @param public_key_len        The length of the public key buffer
-   @param parameters_type       The parameters' type out of the enum #ltc_asn1_type
+   @param parameters_type       The parameters' type out of the enum ltc_asn1_type
    @param parameters            The parameters to include
    @param parameters_len        The number of parameters to include
    @return CRYPT_OK on success

src/prngs/chacha20.c

@@ -31,7 +31,7 @@ const struct ltc_prng_descriptor chacha20_prng_desc =
 
 /**
   Start the PRNG
-  @param prng[out] The PRNG state to initialize
+  @param prng The PRNG state to initialize
   @return CRYPT_OK if successful
 */
 int chacha20_prng_start(prng_state *prng)

src/prngs/rc4.c

@@ -9,7 +9,7 @@
 #include "tomcrypt.h"
 
 /**
-  @file rc4.c
+  @file prngs/rc4.c
   RC4 PRNG, Tom St Denis
 */
 

src/prngs/sober128.c

@@ -10,7 +10,7 @@
 #include "tomcrypt.h"
 
 /**
- @file sober128.c
+ @file prngs/sober128.c
  Implementation of SOBER-128 by Tom St Denis.
  Based on s128fast.c reference code supplied by Greg Rose of QUALCOMM.
 */

src/stream/chacha/chacha_ivctr32.c

@@ -20,7 +20,7 @@
   Set IV + counter data to the ChaCha state
   @param st      The ChaCha20 state
   @param iv      The IV data to add
-  @param inlen   The length of the IV (must be 12)
+  @param ivlen   The length of the IV (must be 12)
   @param counter 32bit (unsigned) initial counter value
   @return CRYPT_OK on success
  */

src/stream/chacha/chacha_ivctr64.c

@@ -20,7 +20,7 @@
   Set IV + counter data to the ChaCha state
   @param st      The ChaCha20 state
   @param iv      The IV data to add
-  @param inlen   The length of the IV (must be 8)
+  @param ivlen   The length of the IV (must be 8)
   @param counter 64bit (unsigned) initial counter value
   @return CRYPT_OK on success
  */

src/stream/sober128/sober128.c

@@ -9,7 +9,7 @@
 #include "tomcrypt.h"
 
 /**
- @file sober128.c
+ @file stream/sober128/sober128.c
  Implementation of SOBER-128 by Tom St Denis.
  Based on s128fast.c reference code supplied by Greg Rose of QUALCOMM.
 */
@@ -203,7 +203,7 @@ int sober128_stream_setup(sober128_state *c, const unsigned char *key, unsigned
   Set IV to the Sober128 state
   @param c       The Sober12820 state
   @param iv      The IV data to add
-  @param inlen   The length of the IV (must be 12)
+  @param ivlen   The length of the IV (must be 12)
   @return CRYPT_OK on success
  */
 int sober128_stream_setiv(sober128_state *c, const unsigned char *iv, unsigned long ivlen)