From db641b9258c41c93fc922197cb20aac9f6ff2fa4 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Thu, 28 Sep 2017 04:42:48 -0400 Subject: [PATCH] Update documentation --- pubkey.h | 2 +- threefish.h | 15 +++++++++++++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/pubkey.h b/pubkey.h index 5e5fba0a..de2687af 100644 --- a/pubkey.h +++ b/pubkey.h @@ -298,7 +298,7 @@ public: DecodingResult Decrypt(RandomNumberGenerator &rng, const byte *ciphertext, size_t ciphertextLength, byte *plaintext, const NameValuePairs ¶meters = g_nullNameValuePairs) const; }; -//! \class TF_DecryptorBase +//! \class TF_EncryptorBase //! \brief Trapdoor function cryptosystems encryption base class class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE TF_EncryptorBase : public TF_CryptoSystemBase > { diff --git a/threefish.h b/threefish.h index 5294a273..69455d85 100644 --- a/threefish.h +++ b/threefish.h @@ -56,13 +56,16 @@ struct Threefish_Info : public VariableBlockSize<32, 32, 128> } }; -//! \class Threefish1024 -//! \brief Threefish-1024 block cipher +//! \class Threefish +//! \brief Threefish block cipher //! \sa Threefish //! \since Crypto++ 6.0 class Threefish : public Threefish_Info, public BlockCipherDocumentation { public: + //! \brief Threefish block cipher data processing functions + //! \details Provides implementation common to encryption and decryption + //! \since Crypto++ 6.0 class CRYPTOPP_NO_VTABLE Base : public VariableBlockCipherImpl { public: @@ -84,6 +87,10 @@ public: AlignedSecBlock64 m_tweak; }; + //! \brief Provides implementation for encryption transformation + //! \details Enc provides implementation for encryption transformation. All key and block + //! sizes are supported. + //! \since Crypto++ 6.0 class CRYPTOPP_NO_VTABLE Enc : public Base { protected: @@ -94,6 +101,10 @@ public: void ProcessAndXorBlock_1024(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; + //! \brief Provides implementation for decryption transformation + //! \details Dec provides implementation for encryption transformation. All key and block + //! sizes are supported. + //! \since Crypto++ 6.0 class CRYPTOPP_NO_VTABLE Dec : public Base { protected: