From 2e440959b1e8a9d215d73631eb479a39d0d1a3f0 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Wed, 13 Feb 2019 00:01:58 -0500 Subject: [PATCH] Update documentation --- keccak.h | 2 ++ sha3.h | 3 +++ shake.h | 2 ++ 3 files changed, 7 insertions(+) diff --git a/keccak.h b/keccak.h index ecda97e1..38e0b680 100644 --- a/keccak.h +++ b/keccak.h @@ -45,6 +45,8 @@ protected: /// \details Keccak is the base class for Keccak_224, Keccak_256, Keccak_384 and Keccak_512. /// Library users should instantiate a derived class, and only use Keccak /// as a base class reference or pointer. + /// \details This constructor was moved to protected at Crypto++ 8.1 + /// because users were attempting to create Keccak objects with it. /// \since Crypto++ 5.6.4 Keccak(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} diff --git a/sha3.h b/sha3.h index 54ae5371..1c5d88bb 100644 --- a/sha3.h +++ b/sha3.h @@ -32,6 +32,9 @@ protected: /// \details SHA3 is the base class for SHA3_224, SHA3_256, SHA3_384 and SHA3_512. /// Library users should instantiate a derived class, and only use SHA3 /// as a base class reference or pointer. + /// \details This constructor was moved to protected at Crypto++ 8.1 + /// because users were attempting to create Keccak objects with it. + /// \since Crypto++ 5.6.2 SHA3(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} public: diff --git a/shake.h b/shake.h index 98b1de3d..e9ce38a8 100644 --- a/shake.h +++ b/shake.h @@ -31,6 +31,8 @@ protected: /// \details SHAKE is the base class for SHAKE128 and SHAKE256. /// Library users should instantiate a derived class, and only use SHAKE /// as a base class reference or pointer. + /// \details This constructor was moved to protected at Crypto++ 8.1 + /// because users were attempting to create Keccak objects with it. /// \since Crypto++ 8.1 SHAKE(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}