summaryrefslogtreecommitdiff
path: root/scrypt.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2020-12-07 23:35:10 -0500
committerJeffrey Walton <noloader@gmail.com>2020-12-07 23:35:10 -0500
commitac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb (patch)
treea0f63ebf397db67a1d8f7e41f2e4e89d03a57a4f /scrypt.h
parent4d2b58c8fe92e7ce5007d2f15f046d33f37eedc2 (diff)
downloadcryptopp-git-ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb.tar.gz
Use \return and \throw consitently in the docs
Diffstat (limited to 'scrypt.h')
-rw-r--r--scrypt.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/scrypt.h b/scrypt.h
index 37c0161d..924c1f18 100644
--- a/scrypt.h
+++ b/scrypt.h
@@ -66,8 +66,8 @@ public:
/// \param cost the CPU/memory cost factor
/// \param blockSize the block size
/// \param parallelization the parallelization factor
- /// \returns the number of iterations performed
- /// \throws InvalidDerivedKeyLength if <tt>derivedLen</tt> is invalid for the scheme
+ /// \return the number of iterations performed
+ /// \throw InvalidDerivedKeyLength if <tt>derivedLen</tt> is invalid for the scheme
/// \details DeriveKey() provides a standard interface to derive a key from
/// a seed and other parameters. Each class that derives from KeyDerivationFunction
/// provides an overload that accepts most parameters used by the derivation function.