diff options
author | Jeffrey Walton <noloader@gmail.com> | 2021-04-11 13:37:32 -0400 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2021-04-11 13:37:32 -0400 |
commit | b659832c0617d090a0d7d26dfdb06fb0ecd91635 (patch) | |
tree | 55f7fb0dd998d9926f18ffa6fd440d7846da9783 | |
parent | aaebc8dc6fe07bc16683d813a464a512255cd849 (diff) | |
download | cryptopp-git-b659832c0617d090a0d7d26dfdb06fb0ecd91635.tar.gz |
Update documentation
-rw-r--r-- | pubkey.h | 21 |
1 files changed, 14 insertions, 7 deletions
@@ -1400,7 +1400,8 @@ template<class GP> DL_PublicKeyImpl<GP>::~DL_PublicKeyImpl() {}
/// \brief Interface for Elgamal-like signature algorithms
-/// \tparam T Field element
+/// \tparam T Field element type or class
+/// \details Field element <tt>T</tt> can be Integer, ECP or EC2N.
template <class T>
class CRYPTOPP_NO_VTABLE DL_ElgamalLikeSignatureAlgorithm
{
@@ -1468,7 +1469,8 @@ public: };
/// \brief Interface for DL key agreement algorithms
-/// \tparam T Field element
+/// \tparam T Field element type or class
+/// \details Field element <tt>T</tt> can be Integer, ECP or EC2N.
template <class T>
class CRYPTOPP_NO_VTABLE DL_KeyAgreementAlgorithm
{
@@ -1482,7 +1484,8 @@ public: };
/// \brief Interface for key derivation algorithms used in DL cryptosystems
-/// \tparam T Field element
+/// \tparam T Field element type or class
+/// \details Field element <tt>T</tt> can be Integer, ECP or EC2N.
template <class T>
class CRYPTOPP_NO_VTABLE DL_KeyDerivationAlgorithm
{
@@ -1589,7 +1592,8 @@ protected: };
/// \brief Discrete Log (DL) signature scheme signer base implementation
-/// \tparam T Field element
+/// \tparam T Field element type or class
+/// \details Field element <tt>T</tt> can be Integer, ECP or EC2N.
template <class T>
class CRYPTOPP_NO_VTABLE DL_SignerBase : public DL_SignatureSchemeBase<PK_Signer, DL_PrivateKey<T> >
{
@@ -1706,7 +1710,8 @@ protected: };
/// \brief Discret Log (DL) Verifier base class
-/// \tparam T Field element
+/// \tparam T Field element type or class
+/// \details Field element <tt>T</tt> can be Integer, ECP or EC2N.
template <class T>
class CRYPTOPP_NO_VTABLE DL_VerifierBase : public DL_SignatureSchemeBase<PK_Verifier, DL_PublicKey<T> >
{
@@ -1817,7 +1822,8 @@ protected: };
/// \brief Discrete Log (DL) decryptor base implementation
-/// \tparam T Field element
+/// \tparam T Field element type or class
+/// \details Field element <tt>T</tt> can be Integer, ECP or EC2N.
template <class T>
class CRYPTOPP_NO_VTABLE DL_DecryptorBase : public DL_CryptoSystemBase<PK_Decryptor, DL_PrivateKey<T> >
{
@@ -1857,7 +1863,8 @@ public: };
/// \brief Discrete Log (DL) encryptor base implementation
-/// \tparam T Field element
+/// \tparam T Field element type or class
+/// \details Field element <tt>T</tt> can be Integer, ECP or EC2N.
template <class T>
class CRYPTOPP_NO_VTABLE DL_EncryptorBase : public DL_CryptoSystemBase<PK_Encryptor, DL_PublicKey<T> >
{
|