Update documentation

weidai11 · Feb 13, 2019 · 2e44095 · 2e44095
1 parent 8db6fe1
commit 2e44095
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/keccak.h b/keccak.h
@@ -45,6 +45,8 @@ class Keccak : public HashTransformation
     /// \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
@@ -32,6 +32,9 @@ class SHA3 : public HashTransformation
     /// \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
@@ -31,6 +31,8 @@ class SHAKE : public HashTransformation
     /// \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();}