소스 검색

fix doxygen warnings

Steffen Jaeckel 8 년 전
부모
커밋
9092470843

+ 1 - 1
src/headers/tomcrypt_pk.h

@@ -12,7 +12,7 @@ int rand_prime(void *N, long len, prng_state *prng, int wprng);
 int rand_bn_bits(void *N, int bits, prng_state *prng, int wprng);
 int rand_bn_range(void *N, void *limit, prng_state *prng, int wprng);
 
-enum {
+enum public_key_algorithms {
    PKA_RSA,
    PKA_DSA
 };

+ 1 - 1
src/misc/crc32.c

@@ -11,7 +11,7 @@
 #include "tomcrypt.h"
 
 /**
-   @file crc.c
+   @file crc32.c
    CRC-32 checksum algorithm
    Written and placed in the public domain by Wei Dai
    Adapted for libtomcrypt by Steffen Jaeckel

+ 1 - 1
src/modes/xts/xts_done.c

@@ -17,7 +17,7 @@
 #ifdef LTC_XTS_MODE
 
 /** Terminate XTS state
-   @param XTS    The state to terminate
+   @param xts    The state to terminate
 */
 void xts_done(symmetric_xts *xts)
 {

+ 11 - 6
src/pk/asn1/der/sequence/der_decode_subject_public_key_info.c

@@ -9,7 +9,7 @@
  */
 #include "tomcrypt.h"
 /**
-  @file der_encode_sequence_multi.c
+  @file der_decode_subject_public_key_info.c
   ASN.1 DER, encode a Subject Public Key structure --nmav
 */
 
@@ -26,11 +26,16 @@
  * }
  */
 /**
-  Encode a SEQUENCE type using a VA list
-  @param out    [out] Destination for data
-  @param outlen [in/out] Length of buffer and resulting length of output
-  @remark <...> is of the form <type, size, data> (int, unsigned long, void*)
-  @return CRYPT_OK on success
+  Decode a subject public key info
+   @param in      The input buffer
+   @param inlen   The length of the input buffer
+   @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            The parameters to include
+   @param parameters_len        The number of parameters to include
+   @return CRYPT_OK on success
 */
 int der_decode_subject_public_key_info(const unsigned char *in, unsigned long inlen,
         unsigned int algorithm, void* public_key, unsigned long* public_key_len,

+ 11 - 6
src/pk/asn1/der/sequence/der_encode_subject_public_key_info.c

@@ -10,7 +10,7 @@
 #include "tomcrypt.h"
 
 /**
-  @file der_encode_sequence_multi.c
+  @file der_encode_subject_public_key_info.c
   ASN.1 DER, encode a Subject Public Key structure --nmav
 */
 
@@ -27,11 +27,16 @@
  * }
  */
 /**
-  Encode a SEQUENCE type using a VA list
-  @param out    [out] Destination for data
-  @param outlen [in/out] Length of buffer and resulting length of output
-  @remark <...> is of the form <type, size, data> (int, unsigned long, void*)
-  @return CRYPT_OK on success
+  Encode a subject public key info
+   @param out           The output buffer
+   @param outlen        [in/out] Length of buffer and resulting length of output
+   @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            The parameters to include
+   @param parameters_len        The number of parameters to include
+   @return CRYPT_OK on success
 */
 int der_encode_subject_public_key_info(unsigned char *out, unsigned long *outlen,
         unsigned int algorithm, void* public_key, unsigned long public_key_len,

+ 1 - 1
src/pk/rsa/rsa_sign_saltlen_get.c

@@ -11,7 +11,7 @@
 #include "tomcrypt.h"
 
 /**
-  @file rsa_sign_saltlen_get_ex.c
+  @file rsa_sign_saltlen_get.c
   Retrieve the maximum size of the salt, Steffen Jaeckel.
 */