Update documentation

pull/809/head
Jeffrey Walton 2019-02-12 23:52:19 -05:00
parent 57465b5ae3
commit 8db6fe16b4
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
3 changed files with 9 additions and 3 deletions

View File

@ -39,7 +39,7 @@ NAMESPACE_BEGIN(CryptoPP)
/// \since Crypto++ 5.6.4 /// \since Crypto++ 5.6.4
class Keccak : public HashTransformation class Keccak : public HashTransformation
{ {
public: protected:
/// \brief Construct a Keccak /// \brief Construct a Keccak
/// \param digestSize the digest size, in bytes /// \param digestSize the digest size, in bytes
/// \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.
@ -47,6 +47,8 @@ public:
/// as a base class reference or pointer. /// as a base class reference or pointer.
/// \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();}
public:
unsigned int DigestSize() const {return m_digestSize;} unsigned int DigestSize() const {return m_digestSize;}
unsigned int OptimalDataAlignment() const {return GetAlignmentOf<word64>();} unsigned int OptimalDataAlignment() const {return GetAlignmentOf<word64>();}

4
sha3.h
View File

@ -26,13 +26,15 @@ NAMESPACE_BEGIN(CryptoPP)
/// \since Crypto++ 5.6.2 /// \since Crypto++ 5.6.2
class SHA3 : public HashTransformation class SHA3 : public HashTransformation
{ {
public: protected:
/// \brief Construct a SHA3 /// \brief Construct a SHA3
/// \param digestSize the digest size, in bytes /// \param digestSize the digest size, in bytes
/// \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.
SHA3(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} SHA3(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}
public:
unsigned int DigestSize() const {return m_digestSize;} unsigned int DigestSize() const {return m_digestSize;}
unsigned int OptimalDataAlignment() const {return GetAlignmentOf<word64>();} unsigned int OptimalDataAlignment() const {return GetAlignmentOf<word64>();}

View File

@ -25,7 +25,7 @@ NAMESPACE_BEGIN(CryptoPP)
/// \since Crypto++ 8.1 /// \since Crypto++ 8.1
class SHAKE : public HashTransformation class SHAKE : public HashTransformation
{ {
public: protected:
/// \brief Construct a SHAKE /// \brief Construct a SHAKE
/// \param digestSize the digest size, in bytes /// \param digestSize the digest size, in bytes
/// \details SHAKE is the base class for SHAKE128 and SHAKE256. /// \details SHAKE is the base class for SHAKE128 and SHAKE256.
@ -33,6 +33,8 @@ public:
/// as a base class reference or pointer. /// as a base class reference or pointer.
/// \since Crypto++ 8.1 /// \since Crypto++ 8.1
SHAKE(unsigned int digestSize) : m_digestSize(digestSize) {Restart();} SHAKE(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}
public:
unsigned int DigestSize() const {return m_digestSize;} unsigned int DigestSize() const {return m_digestSize;}
unsigned int OptimalDataAlignment() const {return GetAlignmentOf<word64>();} unsigned int OptimalDataAlignment() const {return GetAlignmentOf<word64>();}