Updated documentation

1 files changed, 6 insertions, 2 deletions

diff --git a/sha3.h b/sha3.h
index ed3a03b8..0337fbac 100644
--- a/sha3.h
+++ b/sha3.h
@@ -3,7 +3,7 @@
 //! \file sha3.h

 //! \brief Classes for SHA-3 message digests

 //! \details The Crypto++ SHA-3 conforms to FIPS 202 version of SHA-3.

-//!   Previous behavior is available in Keccak classes.

+//!   Previous behavior is available in SHA3 classes.

 //! \sa <a href="http://en.wikipedia.org/wiki/SHA-3">SHA-3</a>,

 //!   <A HREF="http://csrc.nist.gov/groups/ST/hash/sha-3/fips202_standard_2015.html">SHA-3 STANDARD (FIPS 202)</A>.

 

@@ -17,13 +17,17 @@ NAMESPACE_BEGIN(CryptoPP)
 

 //! \class SHA3

 //! \brief SHA3 message digest base class

+	//! \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.

+	//! \sa Keccak, SHA3_224, SHA3_256, SHA3_384 and SHA3_512.

 class SHA3 : public HashTransformation

 {

 public:

 	//! \brief Construct a SHA3

 	//! \param digestSize the digest size, in bytes

 	//! \details SHA3 is the base class for SHA3_224, SHA3_256, SHA3_384 and SHA3_512.

-	//!   Library users should construct a derived class instead, and only use SHA3

+	//!   Library users should instantiate a derived class, and only use SHA3

 	//!   as a base class reference or pointer.

 	SHA3(unsigned int digestSize) : m_digestSize(digestSize) {Restart();}

 	unsigned int DigestSize() const {return m_digestSize;}