aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2018-09-10 14:07:14 -0400
committerJack Lloyd <[email protected]>2018-09-10 14:07:14 -0400
commita9e2abdf4a49dcca7e09cc285aef39315dffa252 (patch)
tree462dd74a7e6c7726a4ede7640a3051646f1d04ef /src/lib
parent63493f2ccd66d453b5a4e1e92a8a39278ab0cf28 (diff)
Fix Doxygen comments
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/ffi/ffi.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/lib/ffi/ffi.h b/src/lib/ffi/ffi.h
index 6525b80cc..0a537491c 100644
--- a/src/lib/ffi/ffi.h
+++ b/src/lib/ffi/ffi.h
@@ -552,13 +552,15 @@ BOTAN_PUBLIC_API(2,0) int botan_pbkdf_timed(const char* pbkdf_algo,
/*
* Derive a key from a passphrase
-* @param pbkdf_algo PBKDF algorithm, e.g., "PBKDF2(SHA-256)"
+* @param algo PBKDF algorithm, e.g., "PBKDF2(SHA-256)" or "Scrypt"
+* @param param1 the first PBKDF algorithm parameter
+* @param param2 the second PBKDF algorithm parameter (may be zero if unneeded)
+* @param param3 the third PBKDF algorithm parameter (may be zero if unneeded)
* @param out buffer to store the derived key, must be of out_len bytes
* @param out_len the desired length of the key to produce
* @param passphrase the password to derive the key from
* @param salt a randomly chosen salt
* @param salt_len length of salt in bytes
-* @param iterations the number of iterations to use (use 10K or more)
* @return 0 on success, a negative value on failure
*/
int BOTAN_PUBLIC_API(2,8) botan_pwdhash(