Update documentation

1 files changed, 13 insertions, 3 deletions

diff --git a/sha3.h b/sha3.h
index a5ded799..46dd5b99 100644
--- a/sha3.h
+++ b/sha3.h
@@ -56,16 +56,26 @@ class SHA3_Final : public SHA3
 public:

     CRYPTOPP_CONSTANT(DIGESTSIZE = T_DigestSize)

     CRYPTOPP_CONSTANT(BLOCKSIZE = 200 - 2 * DIGESTSIZE)

+    static std::string StaticAlgorithmName()

+        { return "SHA3-" + IntToString(DIGESTSIZE * 8); }

 

     /// \brief Construct a SHA3-X message digest

     SHA3_Final() : SHA3(DIGESTSIZE) {}

-    static std::string StaticAlgorithmName() { return "SHA3-" + IntToString(DIGESTSIZE * 8); }

+

+    /// \brief Provides the block size of the compression function

+    /// \return block size of the compression function, in bytes

+    /// \details BlockSize() will return 0 if the hash is not block based

+    ///   or does not have an equivalent block size. For example, Keccak

+    ///   and SHA-3 do not have a block size, but they do have an equivalent

+    ///   block size called rate expressed as <tt>r</tt>.

     unsigned int BlockSize() const { return BLOCKSIZE; }

 

 private:

 #if !defined(__BORLANDC__)

-    CRYPTOPP_COMPILE_ASSERT(BLOCKSIZE < 200); // ensure there was no underflow in the math

-    CRYPTOPP_COMPILE_ASSERT(BLOCKSIZE > (int)T_DigestSize); // this is a general expectation by HMAC

+    // ensure there was no underflow in the math

+    CRYPTOPP_COMPILE_ASSERT(BLOCKSIZE < 200);

+    // this is a general expectation by HMAC

+    CRYPTOPP_COMPILE_ASSERT(BLOCKSIZE > (int)T_DigestSize);

 #endif

 };