Updated doxygen documentation in header files and HTML pages

include/polarssl/aes.h

@@ -128,7 +128,6 @@ int aes_crypt_cbc( aes_context *ctx,
  * both encryption and decryption. So a context initialized with
  * aes_setkey_enc() for both AES_ENCRYPT and AES_DECRYPT.
  *
- * both 
  * \param ctx      AES context
  * \param mode     AES_ENCRYPT or AES_DECRYPT
  * \param length   length of the input data
@@ -156,6 +155,7 @@ int aes_crypt_cfb128( aes_context *ctx,
  * both encryption and decryption. So a context initialized with
  * aes_setkey_enc() for both AES_ENCRYPT and AES_DECRYPT.
  *
+ * \param ctx           AES context
  * \param length        The length of the data
  * \param nc_off        The offset in the current stream_block (for resuming
  *                      within current cipher stream). The offset pointer to

include/polarssl/blowfish.h

@@ -116,7 +116,6 @@ int blowfish_crypt_cbc( blowfish_context *ctx,
 /**
  * \brief          Blowfish CFB buffer encryption/decryption.
  *
- * both 
  * \param ctx      Blowfish context
  * \param mode     BLOWFISH_ENCRYPT or BLOWFISH_DECRYPT
  * \param length   length of the input data
@@ -140,6 +139,7 @@ int blowfish_crypt_cfb64( blowfish_context *ctx,
  *
  * Warning: You have to keep the maximum use of your counter in mind!
  *
+ * \param ctx           Blowfish context
  * \param length        The length of the data
  * \param nc_off        The offset in the current stream_block (for resuming
  *                      within current cipher stream). The offset pointer to

include/polarssl/camellia.h

@@ -134,7 +134,7 @@ int camellia_crypt_cbc( camellia_context *ctx,
  * \param iv       initialization vector (updated after use)
  * \param input    buffer holding the input data
  * \param output   buffer holding the output data
- * 
+ *
  * \return         0 if successful, or POLARSSL_ERR_CAMELLIA_INVALID_INPUT_LENGTH
  */
 int camellia_crypt_cfb128( camellia_context *ctx,
@@ -154,6 +154,7 @@ int camellia_crypt_cfb128( camellia_context *ctx,
  * both encryption and decryption. So a context initialized with
  * camellia_setkey_enc() for both CAMELLIA_ENCRYPT and CAMELLIA_DECRYPT.
  *
+ * \param ctx           CAMELLIA context
  * \param length        The length of the data
  * \param nc_off        The offset in the current stream_block (for resuming
  *                      within current cipher stream). The offset pointer to

include/polarssl/cipher.h

@@ -479,6 +479,7 @@ int cipher_set_padding_mode( cipher_context_t *ctx, cipher_padding_t mode );
 /**
  * \brief               Set the initialization vector (IV) or nonce
  *
+ * \param ctx           generic cipher context
  * \param iv            IV to use (or NONCE_COUNTER for CTR-mode ciphers)
  * \param iv_len        IV length for ciphers with variable-size IV;
  *                      discarded by ciphers with fixed-size IV.
@@ -579,6 +580,7 @@ int cipher_finish( cipher_context_t *ctx,
  *                      No effect for other ciphers.
  *                      Must be called after cipher_finish().
  *
+ * \param ctx           Generic cipher context
  * \param tag           buffer to write the tag
  * \param tag_len       Length of the tag to write
  *
@@ -593,6 +595,7 @@ int cipher_write_tag( cipher_context_t *ctx,
  *                      Calling time depends on the cipher:
  *                      for GCM, must be called after cipher_finish().
  *
+ * \param ctx           Generic cipher context
  * \param tag           Buffer holding the tag
  * \param tag_len       Length of the tag to check
  *

include/polarssl/config.h

@@ -1102,7 +1102,6 @@
  * Enable the TCP/IP networking routines.
  *
  * Module:  library/net.c
- * Caller:
  *
  * This module provides TCP/IP networking routines.
  */
@@ -1347,8 +1346,8 @@
  * Caller:  library/havege.c
  *
  * This module is used by the HAVEGE random number generator.
-#define POLARSSL_TIMING_C
  */
+#define POLARSSL_TIMING_C
 
 /**
  * \def POLARSSL_VERSION_C

include/polarssl/ctr_drbg.h

@@ -201,6 +201,7 @@ int ctr_drbg_random( void *p_rng,
 /**
  * \brief               Write a seed file
  *
+ * \param ctx           CTR_DRBG context
  * \param path          Name of the file
  *
  * \return              0 if successful, 1 on file error, or
@@ -212,6 +213,7 @@ int ctr_drbg_write_seed_file( ctr_drbg_context *ctx, const char *path );
  * \brief               Read and update a seed file. Seed is added to this
  *                      instance
  *
+ * \param ctx           CTR_DRBG context
  * \param path          Name of the file
  *
  * \return              0 if successful, 1 on file error,

include/polarssl/ecdh.h

@@ -103,8 +103,9 @@ void ecdh_free( ecdh_context *ctx );
  * \brief           Setup and write the ServerKeyExhange parameters
  *
  * \param ctx       ECDH context
- * \param buf       destination buffer
  * \param olen      number of chars written
+ * \param buf       destination buffer
+ * \param blen      length of buffer
  * \param f_rng     RNG function
  * \param p_rng     RNG parameter
  *
@@ -122,7 +123,7 @@ int ecdh_make_params( ecdh_context *ctx, size_t *olen,
  * \brief           Parse the ServerKeyExhange parameters
  *
  * \param ctx       ECDH context
- * \param buf       $(start of input buffer)
+ * \param buf       pointer to start of input buffer
  * \param end       one past end of buffer
  *
  * \return          0 if successful, or an POLARSSL_ERR_ECP_XXX error code
@@ -137,6 +138,8 @@ int ecdh_read_params( ecdh_context *ctx,
  * \param olen      number of bytes actually written
  * \param buf       destination buffer
  * \param blen      size of destination buffer
+ * \param f_rng     RNG function
+ * \param p_rng     RNG parameter
  *
  * \return          0 if successful, or an POLARSSL_ERR_ECP_XXX error code
  */

include/polarssl/ecdsa.h

@@ -132,7 +132,7 @@ int ecdsa_read_signature( ecdsa_context *ctx,
  * \brief           Generate an ECDSA keypair on the given curve
  *
  * \param ctx       ECDSA context in which the keypair should be stored
- * \param grp       Group (elliptic curve) to use. One of the various
+ * \param gid       Group (elliptic curve) to use. One of the various
  *                  POLARSSL_ECP_DP_XXX macros depending on configuration.
  * \param f_rng     RNG function
  * \param p_rng     RNG parameter

include/polarssl/ecp.h

@@ -315,7 +315,7 @@ int ecp_point_read_binary( const ecp_group *grp, ecp_point *P,
  * \note            Index should be a value of RFC 4492's enum NamdeCurve,
  *                  possibly in the form of a POLARSSL_ECP_DP_XXX macro.
  */
-int ecp_use_known_dp( ecp_group *grp, ecp_group_id id );
+int ecp_use_known_dp( ecp_group *grp, ecp_group_id index );
 
 /**
  * \brief           Set a group from a TLS ECParameters record
@@ -365,8 +365,9 @@ int ecp_tls_read_point( const ecp_group *grp, ecp_point *pt,
  * \param grp       ECP group used
  * \param pt        Point to export
  * \param format    Export format
+ * \param olen      length of data written
  * \param buf       Buffer to write to
- * \param len       Buffer length
+ * \param blen      Buffer length
  *
  * \return          0 if successful,
  *                  or POLARSSL_ERR_ECP_BAD_INPUT_DATA

include/polarssl/oid.h

@@ -413,7 +413,7 @@ int oid_get_sig_alg_desc( const asn1_buf *oid, const char **desc );
  * \return         0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
  */
 int oid_get_oid_by_sig_alg( pk_type_t pk_alg, md_type_t md_alg,
-                            const char **oid_str );
+                            const char **oid );
 
 /**
  * \brief          Translate hash algorithm OID into md_type
@@ -444,7 +444,7 @@ int oid_get_extended_key_usage( const asn1_buf *oid, const char **desc );
  *
  * \return         0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
  */
-int oid_get_oid_by_md( md_type_t md_alg, const char **oid_str );
+int oid_get_oid_by_md( md_type_t md_alg, const char **oid );
 
 #if defined(POLARSSL_CIPHER_C)
 /**

include/polarssl/pk.h

@@ -184,7 +184,7 @@ typedef size_t (*pk_rsa_alt_key_len_func)( void *ctx );
 /**
  * \brief           Return information associated with the given PK type
  *
- * \param type      PK type to search for.
+ * \param pk_type   PK type to search for.
  *
  * \return          The PK info associated with the type or NULL if not found.
  */
@@ -321,6 +321,8 @@ int pk_sign( pk_context *ctx, md_type_t md_alg,
  * \param output    Decrypted output
  * \param olen      Decrypted message lenght
  * \param osize     Size of the output buffer
+ * \param f_rng     RNG function
+ * \param p_rng     RNG parameter
  *
  * \return          0 on success, or a specific error code.
  */
@@ -338,6 +340,8 @@ int pk_decrypt( pk_context *ctx,
  * \param output    Encrypted output
  * \param olen      Encrypted output length
  * \param osize     Size of the output buffer
+ * \param f_rng     RNG function
+ * \param p_rng     RNG parameter
  *
  * \return          0 on success, or a specific error code.
  */

include/polarssl/pkcs5.h

@@ -1,5 +1,5 @@
 /**
- * \file pkcs#5.h
+ * \file pkcs5.h
  *
  * \brief PKCS#5 functions
  *
@@ -59,7 +59,7 @@ extern "C" {
  * \param pbe_params the ASN.1 algorithm parameters
  * \param mode       either PKCS5_DECRYPT or PKCS5_ENCRYPT
  * \param pwd        password to use when generating key
- * \param plen       length of password
+ * \param pwdlen     length of password
  * \param data       data to process
  * \param datalen    length of data
  * \param output     output buffer

include/polarssl/ssl.h

@@ -1000,9 +1000,9 @@ int ssl_set_own_cert_rsa( ssl_context *ssl, x509_cert *own_cert,
  * \param ssl      SSL context
  * \param own_cert own public certificate chain
  * \param rsa_key  alternate implementation private RSA key
- * \param rsa_decrypt_func  alternate implementation of \c rsa_pkcs1_decrypt()
- * \param rsa_sign_func     alternate implementation of \c rsa_pkcs1_sign()
- * \param rsa_key_len_func  function returning length of RSA key in bytes
+ * \param rsa_decrypt  alternate implementation of \c rsa_pkcs1_decrypt()
+ * \param rsa_sign     alternate implementation of \c rsa_pkcs1_sign()
+ * \param rsa_key_len  function returning length of RSA key in bytes
  *
  * \return          0 on success, or a specific error code.
  */
@@ -1135,7 +1135,7 @@ void ssl_set_min_version( ssl_context *ssl, int major, int minor );
  *                 negotiate with the server during handshake)
  *
  * \param ssl      SSL context
- * \param mfl      Code for maximum fragment length (allowed values:
+ * \param mfl_code Code for maximum fragment length (allowed values:
  *                 SSL_MAX_FRAG_LEN_512,  SSL_MAX_FRAG_LEN_1024,
  *                 SSL_MAX_FRAG_LEN_2048, SSL_MAX_FRAG_LEN_4096)
  *

include/polarssl/x509write.h

@@ -84,6 +84,7 @@ typedef struct _x509_csr
 }
 x509_csr;
 
+/* \} name */
 /* \} addtogroup x509_module */
 
 /**
@@ -121,7 +122,7 @@ void x509write_csr_set_rsa_key( x509_csr *ctx, rsa_context *rsa );
  *                  (e.g. POLARSSL_MD_SHA1)
  *
  * \param ctx       CSR context to use
- * \param md_ald    MD algorithm to use
+ * \param md_alg    MD algorithm to use
  */
 void x509write_csr_set_md_alg( x509_csr *ctx, md_type_t md_alg );
 
@@ -206,7 +207,7 @@ int x509write_key_der( rsa_context *rsa, unsigned char *buf, size_t size );
  *                        return value to determine where you should start
  *                        using the buffer
  *
- * \param rsa       CSR to write away
+ * \param ctx       CSR to write away
  * \param buf       buffer to write to
  * \param size      size of the buffer
  *
@@ -242,7 +243,7 @@ int x509write_key_pem( rsa_context *rsa, unsigned char *buf, size_t size );
  * \brief           Write a CSR (Certificate Signing Request) to a
  *                  PEM string
  *
- * \param rsa       CSR to write away
+ * \param ctx       CSR to write away
  * \param buf       buffer to write to
  * \param size      size of the buffer
  *