You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by rj...@apache.org on 2010/07/25 19:38:56 UTC
svn commit: r979075 - in /apr/apr/trunk: crypto/apr_crypto_nss.c
crypto/apr_crypto_openssl.c include/private/apr_crypto_internal.h
Author: rjung
Date: Sun Jul 25 17:38:56 2010
New Revision: 979075
URL: http://svn.apache.org/viewvc?rev=979075&view=rev
Log:
Fix APR crypto doxygen docs (function params).
Modified:
apr/apr/trunk/crypto/apr_crypto_nss.c
apr/apr/trunk/crypto/apr_crypto_openssl.c
apr/apr/trunk/include/private/apr_crypto_internal.h
Modified: apr/apr/trunk/crypto/apr_crypto_nss.c
URL: http://svn.apache.org/viewvc/apr/apr/trunk/crypto/apr_crypto_nss.c?rev=979075&r1=979074&r2=979075&view=diff
==============================================================================
--- apr/apr/trunk/crypto/apr_crypto_nss.c (original)
+++ apr/apr/trunk/crypto/apr_crypto_nss.c Sun Jul 25 17:38:56 2010
@@ -166,8 +166,7 @@ static apr_status_t crypto_init(apr_pool
/**
* @brief Clean encryption / decryption context.
* @note After cleanup, a context is free to be reused if necessary.
- * @param driver - driver to use
- * @param ctx The block context to use.
+ * @param block The block context to use.
* @return Returns APR_ENOTIMPL if not supported.
*/
static apr_status_t crypto_block_cleanup(apr_crypto_block_t *block)
@@ -191,7 +190,6 @@ static apr_status_t crypto_block_cleanup
/**
* @brief Clean encryption / decryption context.
* @note After cleanup, a context is free to be reused if necessary.
- * @param driver - driver to use
* @param f The context to use.
* @return Returns APR_ENOTIMPL if not supported.
*/
@@ -220,10 +218,10 @@ static apr_status_t crypto_cleanup_helpe
* algorithms and other parameters will be set per context. More than
* one context can be created at one time. A cleanup will be automatically
* registered with the given pool to guarantee a graceful shutdown.
- * @param driver - driver to use
* @param pool - process pool
+ * @param provider - provider to use
* @param params - array of key parameters
- * @param context - context pointer will be written here
+ * @param ff - context pointer will be written here
* @return APR_ENOENGINE when the engine specified does not exist. APR_EINITENGINE
* if the engine cannot be initialised.
*/
@@ -284,7 +282,6 @@ static apr_status_t crypto_make(apr_pool
* operations.
* @note If *key is NULL, a apr_crypto_key_t will be created from a pool. If
* *key is not NULL, *key must point at a previously created structure.
- * @param driver - driver to use
* @param p The pool to use.
* @param f The context to use.
* @param pass The passphrase to use.
@@ -294,6 +291,7 @@ static apr_status_t crypto_make(apr_pool
* @param type 3DES_192, AES_128, AES_192, AES_256.
* @param mode Electronic Code Book / Cipher Block Chaining.
* @param doPad Pad if necessary.
+ * @param iterations Iteration count
* @param key The key returned, see note.
* @param ivSize The size of the initialisation vector will be returned, based
* on whether an IV is relevant for this type of crypto.
@@ -517,7 +515,7 @@ static apr_status_t crypto_block_encrypt
* to NULL, a buffer sufficiently large will be created from
* the pool provided. If *out points to a not-NULL value, this
* value will be used as a buffer instead.
- * @param ctx The block context to use.
+ * @param block The block context to use.
* @param out Address of a buffer to which data will be written,
* see note.
* @param outlen Length of the output will be written here.
@@ -570,7 +568,7 @@ static apr_status_t crypto_block_encrypt
* number of bytes returned as actually written by the
* apr_crypto_block_encrypt() call. After this call, the context
* is cleaned and can be reused by apr_crypto_block_encrypt_init().
- * @param ctx The block context to use.
+ * @param block The block context to use.
* @param out Address of a buffer to which data will be written. This
* buffer must already exist, and is usually the same
* buffer used by apr_evp_crypt(). See note.
@@ -685,7 +683,7 @@ static apr_status_t crypto_block_decrypt
* to NULL, a buffer sufficiently large will be created from
* the pool provided. If *out points to a not-NULL value, this
* value will be used as a buffer instead.
- * @param ctx The block context to use.
+ * @param block The block context to use.
* @param out Address of a buffer to which data will be written,
* see note.
* @param outlen Length of the output will be written here.
@@ -738,7 +736,7 @@ static apr_status_t crypto_block_decrypt
* bytes returned as actually written by the apr_evp_crypt()
* call. After this call, the context is cleaned and can be
* reused by apr_env_encrypt_init() or apr_env_decrypt_init().
- * @param ctx The block context to use.
+ * @param block The block context to use.
* @param out Address of a buffer to which data will be written. This
* buffer must already exist, and is usually the same
* buffer used by apr_evp_crypt(). See note.
Modified: apr/apr/trunk/crypto/apr_crypto_openssl.c
URL: http://svn.apache.org/viewvc/apr/apr/trunk/crypto/apr_crypto_openssl.c?rev=979075&r1=979074&r2=979075&view=diff
==============================================================================
--- apr/apr/trunk/crypto/apr_crypto_openssl.c (original)
+++ apr/apr/trunk/crypto/apr_crypto_openssl.c Sun Jul 25 17:38:56 2010
@@ -109,7 +109,6 @@ static apr_status_t crypto_init(apr_pool
/**
* @brief Clean encryption / decryption context.
* @note After cleanup, a context is free to be reused if necessary.
- * @param driver - driver to use
* @param ctx The block context to use.
* @return Returns APR_ENOTIMPL if not supported.
*/
@@ -132,7 +131,6 @@ static apr_status_t crypto_block_cleanup
/**
* @brief Clean encryption / decryption context.
* @note After cleanup, a context is free to be reused if necessary.
- * @param driver - driver to use
* @param f The context to use.
* @return Returns APR_ENOTIMPL if not supported.
*/
@@ -157,10 +155,10 @@ static apr_status_t crypto_cleanup_helpe
* algorithms and other parameters will be set per context. More than
* one context can be created at one time. A cleanup will be automatically
* registered with the given pool to guarantee a graceful shutdown.
- * @param driver - driver to use
* @param pool - process pool
+ * @param provider - provider to use
* @param params - array of key parameters
- * @param context - context pointer will be written here
+ * @param ff - context pointer will be written here
* @return APR_ENOENGINE when the engine specified does not exist. APR_EINITENGINE
* if the engine cannot be initialised.
*/
@@ -219,7 +217,6 @@ static apr_status_t crypto_make(apr_pool
* operations.
* @note If *key is NULL, a apr_crypto_key_t will be created from a pool. If
* *key is not NULL, *key must point at a previously created structure.
- * @param driver - driver to use
* @param p The pool to use.
* @param f The context to use.
* @param pass The passphrase to use.
@@ -229,6 +226,7 @@ static apr_status_t crypto_make(apr_pool
* @param type 3DES_192, AES_128, AES_192, AES_256.
* @param mode Electronic Code Book / Cipher Block Chaining.
* @param doPad Pad if necessary.
+ * @param iterations Iteration count
* @param key The key returned, see note.
* @param ivSize The size of the initialisation vector will be returned, based
* on whether an IV is relevant for this type of crypto.
@@ -335,12 +333,8 @@ static apr_status_t crypto_passphrase(ap
* *ctx is not NULL, *ctx must point at a previously created structure.
* @param p The pool to use.
* @param f The block context to use.
- * @param type 3DES_192, AES_128, AES_192, AES_256.
- * @param mode Electronic Code Book / Cipher Block Chaining.
* @param key The key
- * @param keyLen The key length in bytes
* @param iv Optional initialisation vector.
- * @param doPad Pad if necessary.
* @param ctx The block context returned, see note.
* @param blockSize The block size of the cipher.
* @return Returns APR_ENOIV if an initialisation vector is required but not specified.
Modified: apr/apr/trunk/include/private/apr_crypto_internal.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/private/apr_crypto_internal.h?rev=979075&r1=979074&r2=979075&view=diff
==============================================================================
--- apr/apr/trunk/include/private/apr_crypto_internal.h (original)
+++ apr/apr/trunk/include/private/apr_crypto_internal.h Sun Jul 25 17:38:56 2010
@@ -37,6 +37,7 @@ struct apr_crypto_driver_t {
* Called once only.
* @param pool The pool to register the cleanup in.
* @param params An array of optional init parameters.
+ * @param rc Driver-specific additional error code
*/
apr_status_t (*init)(apr_pool_t *pool, const apr_array_header_t *params, int *rc);
@@ -45,7 +46,7 @@ struct apr_crypto_driver_t {
* algorithms and other parameters will be set per context. More than
* one context can be created at one time. A cleanup will be automatically
* registered with the given pool to guarantee a graceful shutdown.
- * @param driver - driver to use
+ * @param provider - provider to use
* @param pool - process pool
* @param params - array of key parameters
* @param f - context pointer will be written here
@@ -64,7 +65,6 @@ struct apr_crypto_driver_t {
* operations.
* @note If *key is NULL, a apr_crypto_key_t will be created from a pool. If
* *key is not NULL, *key must point at a previously created structure.
- * @param driver - driver to use
* @param p The pool to use.
* @param f The context to use.
* @param pass The passphrase to use.
@@ -74,6 +74,7 @@ struct apr_crypto_driver_t {
* @param type 3DES_192, AES_128, AES_192, AES_256.
* @param mode Electronic Code Book / Cipher Block Chaining.
* @param doPad Pad if necessary.
+ * @param iterations Iteration count
* @param key The key returned, see note.
* @param ivSize The size of the initialisation vector will be returned, based
* on whether an IV is relevant for this type of crypto.
@@ -101,8 +102,6 @@ struct apr_crypto_driver_t {
* If the buffer pointed to is not NULL, the IV in the buffer will be
* used.
* @param ctx The block context returned, see note.
- * @param ivSize The size of the initialisation vector will be returned, based
- * on whether an IV is relevant for this type of crypto.
* @param blockSize The block size of the cipher.
* @return Returns APR_ENOIV if an initialisation vector is required but not specified.
* Returns APR_EINIT if the backend failed to initialise the context. Returns
@@ -219,7 +218,6 @@ struct apr_crypto_driver_t {
/**
* @brief Clean encryption / decryption context.
* @note After cleanup, a context is free to be reused if necessary.
- * @param driver - driver to use
* @param ctx The block context to use.
* @return Returns APR_ENOTIMPL if not supported.
*/
@@ -228,7 +226,6 @@ struct apr_crypto_driver_t {
/**
* @brief Clean encryption / decryption context.
* @note After cleanup, a context is free to be reused if necessary.
- * @param driver - driver to use
* @param f The context to use.
* @return Returns APR_ENOTIMPL if not supported.
*/