aboutsummaryrefslogtreecommitdiffstats
path: root/src/pbe
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-07-09 19:36:23 +0000
committerlloyd <[email protected]>2012-07-09 19:36:23 +0000
commite20279e07b37f9cff036b6e4bd6e11532de0f363 (patch)
treeef3ba8c2dbe9ec216f39a090b1b1e7353f171e03 /src/pbe
parentf598db001a535d88d603d954df8532a4020a3cfe (diff)
Doxygen warning fixes
Diffstat (limited to 'src/pbe')
-rw-r--r--src/pbe/get_pbe.h6
1 files changed, 5 insertions, 1 deletions
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);
}