Updated documentation (Issue 130)

1 files changed, 25 insertions, 3 deletions

diff --git a/sha3.h b/sha3.h
index 83d8432e..2284d92b 100644
--- a/sha3.h
+++ b/sha3.h
@@ -1,7 +1,6 @@
 // sha3.h - written and placed in the public domain by Wei Dai

 

-//! \file

-//! \headerfile sha3.h

+//! \file sha3.h

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

 

 #ifndef CRYPTOPP_SHA3_H

@@ -12,10 +11,17 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

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

+//! \class SHA3

+//! \brief SHA3 message digest base class

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

 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

+	//!   as a base class reference or pointer.

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

 	unsigned int DigestSize() const {return m_digestSize;}

 	std::string AlgorithmName() const {return "SHA-3-" + IntToString(m_digestSize*8);}

@@ -32,34 +38,50 @@ protected:
 	unsigned int m_digestSize, m_counter;

 };

 

+//! \class SHA3_224

+//! \brief SHA3-224 message digest

 class SHA3_224 : public SHA3

 {

 public:

 	CRYPTOPP_CONSTANT(DIGESTSIZE = 28)

+		

+	//! \brief Construct a SHA3-224 message digest

 	SHA3_224() : SHA3(DIGESTSIZE) {}

 	static const char * StaticAlgorithmName() {return "SHA-3-224";}

 };

 

+//! \class SHA3_256

+//! \brief SHA3-256 message digest

 class SHA3_256 : public SHA3

 {

 public:

 	CRYPTOPP_CONSTANT(DIGESTSIZE = 32)

+		

+	//! \brief Construct a SHA3-256 message digest

 	SHA3_256() : SHA3(DIGESTSIZE) {}

 	static const char * StaticAlgorithmName() {return "SHA-3-256";}

 };

 

+//! \class SHA3_384

+//! \brief SHA3-384 message digest

 class SHA3_384 : public SHA3

 {

 public:

 	CRYPTOPP_CONSTANT(DIGESTSIZE = 48)

+		

+	//! \brief Construct a SHA3-384 message digest

 	SHA3_384() : SHA3(DIGESTSIZE) {}

 	static const char * StaticAlgorithmName() {return "SHA-3-384";}

 };

 

+//! \class SHA3_512

+//! \brief SHA3-512 message digest

 class SHA3_512 : public SHA3

 {

 public:

 	CRYPTOPP_CONSTANT(DIGESTSIZE = 64)

+		

+	//! \brief Construct a SHA3-512 message digest

 	SHA3_512() : SHA3(DIGESTSIZE) {}

 	static const char * StaticAlgorithmName() {return "SHA-3-512";}

 };