Mailing-List: contact commits-help@apr.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@apr.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r979089 - in /apr/apr-util/branches/1.5.x:
 crypto/apr_crypto_nss.c crypto/apr_crypto_openssl.c
 include/private/apr_crypto_internal.h
Date: Sun, 25 Jul 2010 19:02:03 -0000
To: commits@apr.apache.org
From: rjung@apache.org
Message-Id: <20100725190203.B40FC2388903@eris.apache.org>

Author: rjung
Date: Sun Jul 25 19:02:03 2010
New Revision: 979089

URL: http://svn.apache.org/viewvc?rev=979089&view=rev
Log:
Fix APR crypto doxygen docs (function params).

Backport of r979075 from APR trunk.

Modified:
    apr/apr-util/branches/1.5.x/crypto/apr_crypto_nss.c
    apr/apr-util/branches/1.5.x/crypto/apr_crypto_openssl.c
    apr/apr-util/branches/1.5.x/include/private/apr_crypto_internal.h

Modified: apr/apr-util/branches/1.5.x/crypto/apr_crypto_nss.c
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.5.x/crypto/apr_crypto_nss.c?rev=979089&r1=979088&r2=979089&view=diff
==============================================================================
--- apr/apr-util/branches/1.5.x/crypto/apr_crypto_nss.c (original)
+++ apr/apr-util/branches/1.5.x/crypto/apr_crypto_nss.c Sun Jul 25 19:02:03 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,9 @@ 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 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.
  */
@@ -283,7 +280,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.
@@ -293,6 +289,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.
@@ -516,7 +513,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.
@@ -569,7 +566,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.
@@ -684,7 +681,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.
@@ -737,7 +734,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-util/branches/1.5.x/crypto/apr_crypto_openssl.c
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.5.x/crypto/apr_crypto_openssl.c?rev=979089&r1=979088&r2=979089&view=diff
==============================================================================
--- apr/apr-util/branches/1.5.x/crypto/apr_crypto_openssl.c (original)
+++ apr/apr-util/branches/1.5.x/crypto/apr_crypto_openssl.c Sun Jul 25 19:02:03 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,9 @@ 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 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.
  */
@@ -218,7 +215,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.
@@ -228,6 +224,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.
@@ -334,12 +331,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-util/branches/1.5.x/include/private/apr_crypto_internal.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.5.x/include/private/apr_crypto_internal.h?rev=979089&r1=979088&r2=979089&view=diff
==============================================================================
--- apr/apr-util/branches/1.5.x/include/private/apr_crypto_internal.h (original)
+++ apr/apr-util/branches/1.5.x/include/private/apr_crypto_internal.h Sun Jul 25 19:02:03 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,6 @@ 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 pool - process pool
      * @param params - array of key parameters
      * @param f - context pointer will be written here
@@ -64,7 +64,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 +73,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 +101,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 +217,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 +225,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.
      */