summaryrefslogtreecommitdiff
path: root/elgamal.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 /elgamal.h
parent4d2b58c8fe92e7ce5007d2f15f046d33f37eedc2 (diff)
downloadcryptopp-git-ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb.tar.gz
Use \return and \throw consitently in the docs
Diffstat (limited to 'elgamal.h')
-rw-r--r--elgamal.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/elgamal.h b/elgamal.h
index 361f3dd0..8c37769d 100644
--- a/elgamal.h
+++ b/elgamal.h
@@ -142,7 +142,7 @@ struct DL_PublicKey_ElGamal : public BASE
virtual ~DL_PublicKey_ElGamal() {}
/// \brief Retrieves the OID of the algorithm
- /// \returns OID of the algorithm
+ /// \return OID of the algorithm
/// \details DL_PrivateKey_ElGamal provides an override for GetAlgorithmID()
/// to utilize 1.3.14.7.2.1.1. Prior to DL_PrivateKey_ElGamal, the ElGamal
/// keys [mistakenly] used the OID from DSA due to DL_GroupParmaters_GFP().
@@ -173,7 +173,7 @@ struct DL_PrivateKey_ElGamal : public BASE
virtual ~DL_PrivateKey_ElGamal() {}
/// \brief Retrieves the OID of the algorithm
- /// \returns OID of the algorithm
+ /// \return OID of the algorithm
/// \details DL_PrivateKey_ElGamal provides an override for GetAlgorithmID()
/// to utilize 1.3.14.7.2.1.1. Prior to DL_PrivateKey_ElGamal, the ElGamal
/// keys [mistakenly] used the OID from DSA due to DL_GroupParmaters_GFP().
@@ -283,7 +283,7 @@ struct ElGamal
typedef SchemeOptions::PublicKey PublicKey;
/// \brief The algorithm name
- /// \returns the algorithm name
+ /// \return the algorithm name
/// \details StaticAlgorithmName returns the algorithm's name as a static
/// member function.
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "ElgamalEnc/Crypto++Padding";}