aboutsummaryrefslogtreecommitdiffstats
path: root/src/pbe/get_pbe.h
diff options
context:
space:
mode:
authorlloyd <[email protected]>2009-03-02 06:46:08 +0000
committerlloyd <[email protected]>2009-03-02 06:46:08 +0000
commit609339f6237affd7041084382c92320d9768f47f (patch)
tree40f72d2396a18106e49c8c87864e35e95e7a5b04 /src/pbe/get_pbe.h
parentc0646a2441c974cd0598291cbfdb5c6a51fa9b52 (diff)
Update some doxygen comments. Contributed by Charles Brockman in bug #39
Diffstat (limited to 'src/pbe/get_pbe.h')
-rw-r--r--src/pbe/get_pbe.h6
1 files changed, 3 insertions, 3 deletions
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&);