From 540485f3cfa9e53c263c179a76522c1b51db3f9f Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Sat, 15 Oct 2016 03:59:21 -0400 Subject: [PATCH] Updated documentation --- ripemd.h | 25 ++++++++++++++++++------- 1 file 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) -//! RIPEMD-160 -/*! Digest Length = 160 bits */ +//! \class RIPEMD160 +//! \brief RIPEMD-160 message digest +//! \details Digest size is 160-bits. +//! \sa RIPEMD-160 class RIPEMD160 : public IteratedHashWithStaticTransform { 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 RIPEMD-320 class RIPEMD320 : public IteratedHashWithStaticTransform { 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 RIPEMD-128 class RIPEMD128 : public IteratedHashWithStaticTransform { 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 RIPEMD-256 class RIPEMD256 : public IteratedHashWithStaticTransform { public: