summaryrefslogtreecommitdiff
path: root/cryptlib.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2019-02-12 23:38:38 -0500
committerJeffrey Walton <noloader@gmail.com>2019-02-12 23:38:38 -0500
commit57465b5ae3065f2d42a8ac94776957acf1060b4c (patch)
tree981a97eabd2f23aa34abc450e7b6a1f3f9ffbaa2 /cryptlib.h
parent9defd0afcd776b7d3232ff28624c478ec013f8cb (diff)
downloadcryptopp-git-57465b5ae3065f2d42a8ac94776957acf1060b4c.tar.gz
Update documentation
Diffstat (limited to 'cryptlib.h')
-rw-r--r--cryptlib.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/cryptlib.h b/cryptlib.h
index bbd1d87e..4f723fc8 100644
--- a/cryptlib.h
+++ b/cryptlib.h
@@ -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.