diff options
author | Jeffrey Walton <noloader@gmail.com> | 2019-02-12 23:38:38 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2019-02-12 23:38:38 -0500 |
commit | 57465b5ae3065f2d42a8ac94776957acf1060b4c (patch) | |
tree | 981a97eabd2f23aa34abc450e7b6a1f3f9ffbaa2 /cryptlib.h | |
parent | 9defd0afcd776b7d3232ff28624c478ec013f8cb (diff) | |
download | cryptopp-git-57465b5ae3065f2d42a8ac94776957acf1060b4c.tar.gz |
Update documentation
Diffstat (limited to 'cryptlib.h')
-rw-r--r-- | cryptlib.h | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -1129,9 +1129,11 @@ public: unsigned int TagSize() const {return DigestSize();}
/// \brief Provides the block size of the compression function
- /// \return the block size of the compression function, in bytes
- /// \details BlockSize() will return 0 if the hash is not block based. For example,
- /// SHA3 is a recursive hash (not an iterative hash), and it does not have a block size.
+ /// \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>.
virtual unsigned int BlockSize() const {return 0;}
/// \brief Provides the input block size most efficient for this hash.
|