Updated documentation for Crypto++ 1.0 algorithms

1 files changed, 20 insertions, 5 deletions

diff --git a/sha.h b/sha.h
index 86151cc2..f22d0cff 100644
--- a/sha.h
+++ b/sha.h
@@ -18,7 +18,10 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-/// <a href="http://www.weidai.com/scan-mirror/md.html#SHA-1">SHA-1</a>

+//! \class SHA1

+//! \brief SHA-1 message digest

+//! \sa <a href="http://www.weidai.com/scan-mirror/md.html#SHA-1">SHA-1</a>

+//! \since Crypto++ 1.0

 class CRYPTOPP_DLL SHA1 : public IteratedHashWithStaticTransform<word32, BigEndian, 64, 20, SHA1>

 {

 public:

@@ -29,7 +32,10 @@ public:
 

 typedef SHA1 SHA;	// for backwards compatibility

 

-//! implements the SHA-256 standard

+//! \class SHA256

+//! \brief SHA-256 message digest

+//! \sa <a href="http://www.weidai.com/scan-mirror/md.html#SHA-256">SHA-256</a>

+//! \since Crypto++ 4.0

 class CRYPTOPP_DLL SHA256 : public IteratedHashWithStaticTransform<word32, BigEndian, 64, 32, SHA256, 32, true>

 {

 public:

@@ -41,7 +47,10 @@ public:
 	CRYPTOPP_CONSTEXPR static const char * CRYPTOPP_API StaticAlgorithmName() {return "SHA-256";}

 };

 

-//! implements the SHA-224 standard

+//! \class SHA224

+//! \brief SHA-224 message digest

+//! \sa <a href="http://www.weidai.com/scan-mirror/md.html#SHA-224">SHA-224</a>

+//! \since Crypto++ 4.0

 class CRYPTOPP_DLL SHA224 : public IteratedHashWithStaticTransform<word32, BigEndian, 64, 32, SHA224, 28, true>

 {

 public:

@@ -53,7 +62,10 @@ public:
 	CRYPTOPP_CONSTEXPR static const char * CRYPTOPP_API StaticAlgorithmName() {return "SHA-224";}

 };

 

-//! implements the SHA-512 standard

+//! \class SHA512

+//! \brief SHA-512 message digest

+//! \sa <a href="http://www.weidai.com/scan-mirror/md.html#SHA-512">SHA-512</a>

+//! \since Crypto++ 4.0

 class CRYPTOPP_DLL SHA512 : public IteratedHashWithStaticTransform<word64, BigEndian, 128, 64, SHA512, 64, (CRYPTOPP_BOOL_X86|CRYPTOPP_BOOL_X32)>

 {

 public:

@@ -62,7 +74,10 @@ public:
 	CRYPTOPP_CONSTEXPR static const char * CRYPTOPP_API StaticAlgorithmName() {return "SHA-512";}

 };

 

-//! implements the SHA-384 standard

+//! \class SHA384

+//! \brief SHA-384 message digest

+//! \sa <a href="http://www.weidai.com/scan-mirror/md.html#SHA-384">SHA-384</a>

+//! \since Crypto++ 4.0

 class CRYPTOPP_DLL SHA384 : public IteratedHashWithStaticTransform<word64, BigEndian, 128, 64, SHA384, 48, (CRYPTOPP_BOOL_X86|CRYPTOPP_BOOL_X32)>

 {

 public: