diff options
author | Jeffrey Walton <noloader@gmail.com> | 2020-12-07 23:35:10 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2020-12-07 23:35:10 -0500 |
commit | ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb (patch) | |
tree | a0f63ebf397db67a1d8f7e41f2e4e89d03a57a4f /pwdbased.h | |
parent | 4d2b58c8fe92e7ce5007d2f15f046d33f37eedc2 (diff) | |
download | cryptopp-git-ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb.tar.gz |
Use \return and \throw consitently in the docs
Diffstat (limited to 'pwdbased.h')
-rw-r--r-- | pwdbased.h | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -64,8 +64,8 @@ public: /// \param saltLen the size of the salt buffer, in bytes
/// \param iterations the number of iterations
/// \param timeInSeconds the in seconds
- /// \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.
@@ -194,8 +194,8 @@ public: /// \param saltLen the size of the salt buffer, in bytes
/// \param iterations the number of iterations
/// \param timeInSeconds the in seconds
- /// \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.
@@ -355,8 +355,8 @@ public: /// \param saltLen the size of the salt buffer, in bytes
/// \param iterations the number of iterations
/// \param timeInSeconds the in seconds
- /// \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.
|