Fix a few hundred Doxygen warnings

1 files changed, 30 insertions, 27 deletions

diff --git a/src/libstate/lookup.h b/src/libstate/lookup.h
index 5f10bb3f8..64de67489 100644
--- a/src/libstate/lookup.h
+++ b/src/libstate/lookup.h
@@ -105,7 +105,7 @@ inline MessageAuthenticationCode* get_mac(const std::string& algo_spec)
 
 /**
 * String to key algorithm factory method.
-* @param name the name of the desired string to key (S2K) algorithm
+* @param algo_spec the name of the desired string to key (S2K) algorithm
 * @return a pointer to the string to key algorithm object
 */
 BOTAN_DLL S2K* get_s2k(const std::string& algo_spec);
@@ -118,7 +118,7 @@ BOTAN_DLL S2K* get_s2k(const std::string& algo_spec);
 
 /**
 * Factory method for EME (message-encoding methods for encryption) objects
-* @param name the name of the EME to create
+* @param algo_spec the name of the EME to create
 * @return a pointer to the desired EME object
 */
 BOTAN_DLL EME*  get_eme(const std::string& algo_spec);
@@ -126,14 +126,14 @@ BOTAN_DLL EME*  get_eme(const std::string& algo_spec);
 /**
 * Factory method for EMSA (message-encoding methods for signatures
 * with appendix) objects
-* @param name the name of the EME to create
+* @param algo_spec the name of the EME to create
 * @return a pointer to the desired EME object
 */
 BOTAN_DLL EMSA* get_emsa(const std::string& algo_spec);
 
 /**
 * Factory method for KDF (key derivation function)
-* @param name the name of the KDF to create
+* @param algo_spec the name of the KDF to create
 * @return a pointer to the desired KDF object
 */
 BOTAN_DLL KDF*  get_kdf(const std::string& algo_spec);
@@ -152,10 +152,11 @@ BOTAN_DLL KDF*  get_kdf(const std::string& algo_spec);
 * or decrypting filter
 * @return a pointer to the encryption or decryption filter
 */
-BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name,
+BOTAN_DLL Keyed_Filter* get_cipher(const std::string& algo_spec,
                                    const SymmetricKey& key,
                                    const InitializationVector& iv,
-                                   Cipher_Dir dir);
+                                   Cipher_Dir direction);
+
 /**
 * Factory method for general symmetric cipher filters.
 * @param algo_spec the name of the desired cipher
@@ -165,30 +166,32 @@ BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name,
 * or decrypting filter
 * @return a pointer to the encryption or decryption filter
 */
-BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name,
+BOTAN_DLL Keyed_Filter* get_cipher(const std::string& algo_spec,
                                    const SymmetricKey& key,
-                                   Cipher_Dir dir);
+                                   Cipher_Dir direction);
 
-/** Factory method for general symmetric cipher filters. No key will
-* be set in the filter.
+/**
+* Factory method for general symmetric cipher filters. No key will be
+* set in the filter.
+*
 * @param algo_spec the name of the desired cipher
-
 * @param direction determines whether the filter will be an encrypting or
 * decrypting filter
 * @return a pointer to the encryption or decryption filter
 */
-BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name, Cipher_Dir dir);
+BOTAN_DLL Keyed_Filter* get_cipher(const std::string& algo_spec,
+                                   Cipher_Dir direction);
 
 /**
 * Check if an algorithm exists.
-* @param name the name of the algorithm to check for
+* @param algo_spec the name of the algorithm to check for
 * @return true if the algorithm exists, false otherwise
 */
 BOTAN_DLL bool have_algorithm(const std::string& algo_spec);
 
 /**
 * Check if a block cipher algorithm exists.
-* @param name the name of the algorithm to check for
+* @param algo_spec the name of the algorithm to check for
 * @return true if the algorithm exists, false otherwise
 */
 inline bool have_block_cipher(const std::string& algo_spec)
@@ -199,7 +202,7 @@ inline bool have_block_cipher(const std::string& algo_spec)
 
 /**
 * Check if a stream cipher algorithm exists.
-* @param name the name of the algorithm to check for
+* @param algo_spec the name of the algorithm to check for
 * @return true if the algorithm exists, false otherwise
 */
 inline bool have_stream_cipher(const std::string& algo_spec)
@@ -236,15 +239,15 @@ inline bool have_mac(const std::string& algo_spec)
 
 /**
 * Find out the block size of a certain symmetric algorithm.
-* @param name the name of the algorithm
-* @return the block size of the specified algorithm
+* @param algo_spec the name of the algorithm
+* @return block size of the specified algorithm
 */
 BOTAN_DLL u32bit block_size_of(const std::string& algo_spec);
 
 /**
 * Find out the output length of a certain symmetric algorithm.
-* @param name the name of the algorithm
-* @return the output length of the specified algorithm
+* @param algo_spec the name of the algorithm
+* @return output length of the specified algorithm
 */
 BOTAN_DLL u32bit output_length_of(const std::string& algo_spec);
 
@@ -252,30 +255,30 @@ BOTAN_DLL u32bit output_length_of(const std::string& algo_spec);
 * Find out the whether a certain key length is allowd for a given
 * symmetric algorithm.
 * @param key_len the key length in question
-* @param name the name of the algorithm
+* @param algo_spec the name of the algorithm
 * @return true if the key length is valid for that algorithm, false otherwise
 */
-BOTAN_DLL bool valid_keylength_for(u32bit keylen,
+BOTAN_DLL bool valid_keylength_for(u32bit key_len,
                                    const std::string& algo_spec);
 
 /**
 * Find out the minimum key size of a certain symmetric algorithm.
-* @param name the name of the algorithm
-* @return the minimum key length of the specified algorithm
+* @param algo_spec the name of the algorithm
+* @return minimum key length of the specified algorithm
 */
 BOTAN_DLL u32bit min_keylength_of(const std::string& algo_spec);
 
 /**
 * Find out the maximum key size of a certain symmetric algorithm.
-* @param name the name of the algorithm
-* @return the maximum key length of the specified algorithm
+* @param algo_spec the name of the algorithm
+* @return maximum key length of the specified algorithm
 */
 BOTAN_DLL u32bit max_keylength_of(const std::string& algo_spec);
 
 /**
 * Find out the size any valid key is a multiple of for a certain algorithm.
-* @param name the name of the algorithm
-* @return the size any valid key is a multiple of
+* @param algo_spec the name of the algorithm
+* @return size any valid key is a multiple of
 */
 BOTAN_DLL u32bit keylength_multiple_of(const std::string& algo_spec);