Doxygen warning fixes

6 files changed, 44 insertions, 6 deletions

diff --git a/src/algo_factory/algo_factory.h b/src/algo_factory/algo_factory.h
index 1bec2adf7..201982766 100644
--- a/src/algo_factory/algo_factory.h
+++ b/src/algo_factory/algo_factory.h
@@ -35,7 +35,6 @@ class BOTAN_DLL Algorithm_Factory
    public:
       /**
       * Constructor
-      * @param mf a mutex factory
       */
       Algorithm_Factory();
 
diff --git a/src/codec/pem/pem.h b/src/codec/pem/pem.h
index 24da1448a..a0c6f74aa 100644
--- a/src/codec/pem/pem.h
+++ b/src/codec/pem/pem.h
@@ -44,6 +44,7 @@ inline std::string encode(const secure_vector<byte>& data,
 
 /**
 * Decode PEM data
+* @param pem a datasource containing PEM encoded data
 * @param label is set to the PEM label found for later inspection
 */
 BOTAN_DLL secure_vector<byte> decode(DataSource& pem,
@@ -51,6 +52,7 @@ BOTAN_DLL secure_vector<byte> decode(DataSource& pem,
 
 /**
 * Decode PEM data
+* @param pem a string containing PEM encoded data
 * @param label is set to the PEM label found for later inspection
 */
 BOTAN_DLL secure_vector<byte> decode(const std::string& pem,
@@ -58,6 +60,7 @@ BOTAN_DLL secure_vector<byte> decode(const std::string& pem,
 
 /**
 * Decode PEM data
+* @param pem a datasource containing PEM encoded data
 * @param label is what we expect the label to be
 */
 BOTAN_DLL secure_vector<byte> decode_check_label(
@@ -66,6 +69,7 @@ BOTAN_DLL secure_vector<byte> decode_check_label(
 
 /**
 * Decode PEM data
+* @param pem a string containing PEM encoded data
 * @param label is what we expect the label to be
 */
 BOTAN_DLL secure_vector<byte> decode_check_label(
diff --git a/src/credentials/credentials_manager.h b/src/credentials/credentials_manager.h
index 7510aa91c..8493ccd92 100644
--- a/src/credentials/credentials_manager.h
+++ b/src/credentials/credentials_manager.h
@@ -32,8 +32,11 @@ class BOTAN_DLL Credentials_Manager
       /**
       * Return a list of the certificates of CAs that we trust in this
       * type/context.
+      *
+      * @param type specifies the type of operation occuring
+      *
       * @param context specifies a context relative to type. For instance
-      *  for type "tls-client", context specifies the servers name.
+      *        for type "tls-client", context specifies the servers name.
       */
       virtual std::vector<X509_Certificate> trusted_certificate_authorities(
          const std::string& type,
@@ -47,6 +50,11 @@ class BOTAN_DLL Credentials_Manager
       * This function should throw an exception derived from
       * std::exception with an informative what() result if the
       * certificate chain cannot be verified.
+
+      * @param type specifies the type of operation occuring
+      * @param hostname specifies the purported hostname
+      * @param cert_chain specifies a certificate chain leading to a
+      *        trusted root CA certificate.
       */
       virtual void verify_certificate_chain(
          const std::string& type,
@@ -63,6 +71,10 @@ class BOTAN_DLL Credentials_Manager
       * @param cert_key_types specifies the key types desired ("RSA",
       *                       "DSA", "ECDSA", etc), or empty if there
       *                       is no preference by the caller.
+      *
+      * @param type specifies the type of operation occuring
+      *
+      * @param context specifies a context relative to type.
       */
       virtual std::vector<X509_Certificate> cert_chain(
          const std::vector<std::string>& cert_key_types,
@@ -78,6 +90,10 @@ class BOTAN_DLL Credentials_Manager
       *
       * @param cert_key_type specifies the type of key requested
       *                      ("RSA", "DSA", "ECDSA", etc)
+      *
+      * @param type specifies the type of operation occuring
+      *
+      * @param context specifies a context relative to type.
       */
       std::vector<X509_Certificate> cert_chain_single_type(
          const std::string& cert_key_type,
@@ -95,12 +111,16 @@ class BOTAN_DLL Credentials_Manager
                                            const std::string& context);
 
       /**
-      * Return true if we should attempt SRP authentication
+      * @param type specifies the type of operation occuring
+      * @param context specifies a context relative to type.
+      * @return true if we should attempt SRP authentication
       */
       virtual bool attempt_srp(const std::string& type,
                                const std::string& context);
 
       /**
+      * @param type specifies the type of operation occuring
+      * @param context specifies a context relative to type.
       * @return identifier for client-side SRP auth, if available
                 for this type/context. Should return empty string
                 if password auth not desired/available.
@@ -109,6 +129,8 @@ class BOTAN_DLL Credentials_Manager
                                          const std::string& context);
 
       /**
+      * @param type specifies the type of operation occuring
+      * @param context specifies a context relative to type.
       * @param identifier specifies what identifier we want the
       *        password for. This will be a value previously returned
       *        by srp_identifier.
@@ -131,12 +153,16 @@ class BOTAN_DLL Credentials_Manager
                                 bool generate_fake_on_unknown);
 
       /**
+      * @param type specifies the type of operation occuring
+      * @param context specifies a context relative to type.
       * @return the PSK identity hint for this type/context
       */
       virtual std::string psk_identity_hint(const std::string& type,
                                             const std::string& context);
 
       /**
+      * @param type specifies the type of operation occuring
+      * @param context specifies a context relative to type.
       * @param identity_hint was passed by the server (but may be empty)
       * @return the PSK identity we want to use
       */
@@ -145,6 +171,10 @@ class BOTAN_DLL Credentials_Manager
                                        const std::string& identity_hint);
 
       /**
+      * @param type specifies the type of operation occuring
+      * @param context specifies a context relative to type.
+      * @param identity is a PSK identity previously returned by
+               psk_identity for the same type and context.
       * @return the PSK used for identity, or throw an exception if no
       * key exists
       */
diff --git a/src/libstate/libstate.h b/src/libstate/libstate.h
index a70fd3265..4d0a2b3e7 100644
--- a/src/libstate/libstate.h
+++ b/src/libstate/libstate.h
@@ -95,7 +95,7 @@ class BOTAN_DLL Library_State
       * @param alias the alias to resolve.
       * @return what the alias stands for
       */
-      std::string deref_alias(const std::string&);
+      std::string deref_alias(const std::string& alias);
    private:
       static RandomNumberGenerator* make_global_rng(Algorithm_Factory& af,
                                                     std::mutex& mutex);
diff --git a/src/pbe/get_pbe.h b/src/pbe/get_pbe.h
index 633945983..df87c0547 100644
--- a/src/pbe/get_pbe.h
+++ b/src/pbe/get_pbe.h
@@ -18,6 +18,9 @@ namespace Botan {
 /**
 * Factory function for PBEs.
 * @param algo_spec the name of the PBE algorithm to retrieve
+* @param passphrase the passphrase to use for encryption
+* @param msec how many milliseconds to run the PBKDF
+* @param rng a random number generator
 * @return pointer to a PBE with randomly created parameters
 */
 BOTAN_DLL PBE* get_pbe(const std::string& algo_spec,
@@ -29,11 +32,12 @@ BOTAN_DLL PBE* get_pbe(const std::string& algo_spec,
 * Factory function for PBEs.
 * @param pbe_oid the oid of the desired PBE
 * @param params a DataSource providing the DER encoded parameters to use
+* @param passphrase the passphrase to use for decryption
 * @return pointer to the PBE with the specified parameters
 */
 BOTAN_DLL PBE* get_pbe(const OID& pbe_oid,
                        const std::vector<byte>& params,
-                       const std::string& password);
+                       const std::string& passphrase);
 
 }
 
diff --git a/src/utils/parsing.h b/src/utils/parsing.h
index 12a31a7dd..f0d865ca7 100644
--- a/src/utils/parsing.h
+++ b/src/utils/parsing.h
@@ -35,7 +35,8 @@ BOTAN_DLL std::vector<std::string> split_on(
 * Replace a character in a string
 * @param str the input string
 * @param from_char the character to replace
-* @return to_char the character to replace it with
+* @param to_char the character to replace it with
+* @return str with all instances of from_char replaced by to_char
 */
 BOTAN_DLL std::string replace_char(const std::string& str,
                                    char from_char,