Update documentation

pull/809/head
Jeffrey Walton 2019-02-13 00:01:58 -05:00
parent 8db6fe16b4
commit 2e440959b1
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
3 changed files with 7 additions and 0 deletions

View File

@ -45,6 +45,8 @@ protected:
/// \details Keccak is the base class for Keccak_224, Keccak_256, Keccak_384 and Keccak_512. /// \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 /// Library users should instantiate a derived class, and only use Keccak
/// as a base class reference or pointer. /// 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 /// \since Crypto++ 5.6.4
Keccak(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} Keccak(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}

3
sha3.h
View File

@ -32,6 +32,9 @@ protected:
/// \details SHA3 is the base class for SHA3_224, SHA3_256, SHA3_384 and SHA3_512. /// \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 /// Library users should instantiate a derived class, and only use SHA3
/// as a base class reference or pointer. /// 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();} SHA3(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}
public: public:

View File

@ -31,6 +31,8 @@ protected:
/// \details SHAKE is the base class for SHAKE128 and SHAKE256. /// \details SHAKE is the base class for SHAKE128 and SHAKE256.
/// Library users should instantiate a derived class, and only use SHAKE /// Library users should instantiate a derived class, and only use SHAKE
/// as a base class reference or pointer. /// 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 /// \since Crypto++ 8.1
SHAKE(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} SHAKE(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}