Update some doxygen comments. Contributed by Charles Brockman in bug #39

3 files changed, 28 insertions, 28 deletions

diff --git a/src/libstate/lookup.h b/src/libstate/lookup.h
index 60575aa7f..a00cd3fb1 100644
--- a/src/libstate/lookup.h
+++ b/src/libstate/lookup.h
@@ -46,37 +46,37 @@ retrieve_mac(const std::string&);
 
 /**
 * Block cipher factory method.
-* @param name the name of the desired block cipher
-* @return the block cipher object
+* @param algo_spec the name of the desired block cipher
+* @return a pointer to the block cipher object
 */
 BOTAN_DLL BlockCipher* get_block_cipher(const std::string& name);
 
 
 /**
 * Stream cipher factory method.
-* @param name the name of the desired stream cipher
-* @return the stream cipher object
+* @param algo_spec the name of the desired stream cipher
+* @return a pointer to the stream cipher object
 */
 BOTAN_DLL StreamCipher* get_stream_cipher(const std::string& name);
 
 /**
 * Hash function factory method.
-* @param name the name of the desired hash function
-* @return the hash function object
+* @param algo_spec the name of the desired hash function
+* @return a pointer to the hash function object
 */
 BOTAN_DLL HashFunction* get_hash(const std::string& name);
 
 /**
 * MAC factory method.
-* @param name the name of the desired MAC
-* @return the MAC object
+* @param algo_spec the name of the desired MAC
+* @return a pointer to the MAC object
 */
 BOTAN_DLL MessageAuthenticationCode* get_mac(const std::string& name);
 
 /**
 * String to key algorithm factory method.
 * @param name the name of the desired string to key (S2K) algorithm
-* @return the string to key algorithm object
+* @return a pointer to the string to key algorithm object
 */
 BOTAN_DLL S2K* get_s2k(const std::string& name);
 
@@ -89,7 +89,7 @@ BOTAN_DLL S2K* get_s2k(const std::string& name);
 /**
 * Factory method for EME (message-encoding methods for encryption) objects
 * @param name the name of the EME to create
-* @return the desired EME object
+* @return a pointer to the desired EME object
 */
 BOTAN_DLL EME*  get_eme(const std::string& name);
 
@@ -97,14 +97,14 @@ BOTAN_DLL EME*  get_eme(const std::string& name);
 * Factory method for EMSA (message-encoding methods for signatures
 * with appendix) objects
 * @param name the name of the EME to create
-* @return the desired EME object
+* @return a pointer to the desired EME object
 */
 BOTAN_DLL EMSA* get_emsa(const std::string& name);
 
 /**
 * Factory method for KDF (key derivation function)
 * @param name the name of the KDF to create
-* @return the desired KDF object
+* @return a pointer to the desired KDF object
 */
 BOTAN_DLL KDF*  get_kdf(const std::string& name);
 
@@ -114,13 +114,13 @@ BOTAN_DLL KDF*  get_kdf(const std::string& name);
 
 /**
 * Factory method for general symmetric cipher filters.
-* @param name the name of the desired cipher
+* @param algo_spec the name of the desired cipher
 * @param key the key to be used for encryption/decryption performed by
 * the filter
 * @param iv the initialization vector to be used
-* @param dir determines whether the filter will be an encrypting or decrypting
+* @param direction determines whether the filter will be an encrypting or decrypting
 * filter
-* @return the encryption or decryption filter
+* @return a pointer to the encryption or decryption filter
 */
 BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name,
                                    const SymmetricKey& key,
@@ -128,12 +128,12 @@ BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name,
                                    Cipher_Dir dir);
 /**
 * Factory method for general symmetric cipher filters.
-* @param name the name of the desired cipher
+* @param algo_spec the name of the desired cipher
 * @param key the key to be used for encryption/decryption performed by
 * the filter
-* @param dir determines whether the filter will be an encrypting or decrypting
+* @param direction determines whether the filter will be an encrypting or decrypting
 * filter
-* @return the encryption or decryption filter
+* @return a pointer to the encryption or decryption filter
 */
 BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name,
                                    const SymmetricKey& key,
@@ -141,11 +141,11 @@ BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name,
 
 /** Factory method for general symmetric cipher filters. No key will
 * be set in the filter.
-* @param name the name of the desired cipher
+* @param algo_spec the name of the desired cipher
 
-* @param dir determines whether the filter will be an encrypting or
+* @param direction determines whether the filter will be an encrypting or
 * decrypting filter
-* @return the encryption or decryption filter
+* @return a pointer to the encryption or decryption filter
 */
 BOTAN_DLL Keyed_Filter* get_cipher(const std::string& name, Cipher_Dir dir);
 
@@ -172,14 +172,14 @@ BOTAN_DLL bool have_stream_cipher(const std::string& name);
 
 /**
 * Check if a hash 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_hash(const std::string& name);
 
 /**
 * Check if a MAC 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_mac(const std::string& name);
@@ -205,7 +205,7 @@ BOTAN_DLL u32bit output_length_of(const std::string& name);
 /**
 * Find out the whether a certain key length is allowd for a given
 * symmetric algorithm.
-* @param keylen the key length in question
+* @param key_len the key length in question
 * @param name the name of the algorithm
 * @return true if the key length is valid for that algorithm, false otherwise
 */
diff --git a/src/pbe/get_pbe.h b/src/pbe/get_pbe.h
index 830dbb29f..b73a79c80 100644
--- a/src/pbe/get_pbe.h
+++ b/src/pbe/get_pbe.h
@@ -13,8 +13,8 @@ namespace Botan {
 
 /**
 * Factory function for PBEs.
-* @param pbe_name the name of the PBE algorithm to retrieve
-* @return a PBE with randomly created parameters
+* @param algo_spec the name of the PBE algorithm to retrieve
+* @return a pointer to a PBE with randomly created parameters
 */
 BOTAN_DLL PBE* get_pbe(const std::string&);
 
@@ -22,7 +22,7 @@ BOTAN_DLL PBE* get_pbe(const std::string&);
 * Factory function for PBEs.
 * @param pbe_oid the oid of the desired PBE
 * @param params a DataSource providing the DER encoded parameters to use
-* @return the PBE with the specified parameters
+* @return a pointer to the PBE with the specified parameters
 */
 BOTAN_DLL PBE* get_pbe(const OID&, DataSource&);
 
diff --git a/src/pubkey/ec_dompar/ec_dompar.h b/src/pubkey/ec_dompar/ec_dompar.h
index 9abfafdb4..a567fd88c 100644
--- a/src/pubkey/ec_dompar/ec_dompar.h
+++ b/src/pubkey/ec_dompar/ec_dompar.h
@@ -109,7 +109,7 @@ EC_Domain_Params decode_ber_ec_dompar(SecureVector<byte> const& encoded);
 * an OID.  The demanded OID has to be registered in the InSiTo
 * configuration. Consult the file ec_dompar.cpp for the default
 * configuration.
-* @param the oid of the demanded EC domain parameters
+* @param oid the oid of the demanded EC domain parameters
 * @result the EC domain parameters associated with the OID
 */
 EC_Domain_Params get_EC_Dom_Pars_by_oid(std::string oid);