Updated documentation

1 files changed, 18 insertions, 7 deletions

diff --git a/ripemd.h b/ripemd.h
index b93b1614..fc633f03 100644
--- a/ripemd.h
+++ b/ripemd.h
@@ -10,8 +10,10 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! <a href="http://www.weidai.com/scan-mirror/md.html#RIPEMD-160">RIPEMD-160</a>

-/*! Digest Length = 160 bits */

+//! \class RIPEMD160

+//! \brief RIPEMD-160 message digest

+//! \details Digest size is 160-bits.

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

 class RIPEMD160 : public IteratedHashWithStaticTransform<word32, LittleEndian, 64, 20, RIPEMD160>

 {

 public:

@@ -20,7 +22,10 @@ public:
 	CRYPTOPP_CONSTEXPR static const char *StaticAlgorithmName() {return "RIPEMD-160";}

 };

 

-/*! Digest Length = 320 bits, Security is similar to RIPEMD-160 */

+//! \class RIPEMD320

+//! \brief RIPEMD-320 message digest

+//! \details Digest size is 320-bits.

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

 class RIPEMD320 : public IteratedHashWithStaticTransform<word32, LittleEndian, 64, 40, RIPEMD320>

 {

 public:

@@ -29,8 +34,11 @@ public:
 	CRYPTOPP_CONSTEXPR static const char *StaticAlgorithmName() {return "RIPEMD-320";}

 };

 

-/*! \warning RIPEMD-128 is considered insecure, and should not be used

-	unless you absolutely need it for compatibility. */

+//! \class RIPEMD128

+//! \brief RIPEMD-128 message digest

+//! \details Digest size is 128-bits.

+//! \warning RIPEMD-128 is considered insecure, and should not be used unless you absolutely need it for compatibility.

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

 class RIPEMD128 : public IteratedHashWithStaticTransform<word32, LittleEndian, 64, 16, RIPEMD128>

 {

 public:

@@ -39,8 +47,11 @@ public:
 	CRYPTOPP_CONSTEXPR static const char *StaticAlgorithmName() {return "RIPEMD-128";}

 };

 

-/*! \warning RIPEMD-256 is considered insecure, and should not be used

-	unless you absolutely need it for compatibility. */

+//! \class RIPEMD256

+//! \brief RIPEMD-256 message digest

+//! \details Digest size is 256-bits.

+//! \warning RIPEMD-256 is considered insecure, and should not be used unless you absolutely need it for compatibility.

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

 class RIPEMD256 : public IteratedHashWithStaticTransform<word32, LittleEndian, 64, 32, RIPEMD256>

 {

 public: