From c77029f142e053ee6b1735144abe82baf4bd96d9 Mon Sep 17 00:00:00 2001
From: Jeffrey Walton <noloader@gmail.com>
Date: Wed, 26 Oct 2016 00:38:51 -0400
Subject: Updated documentation for Crypto++ 1.0 algorithms

---
 arc4.h | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

(limited to 'arc4.h')

diff --git a/arc4.h b/arc4.h
index 6c02524c..21268076 100644
--- a/arc4.h
+++ b/arc4.h
@@ -16,8 +16,9 @@ NAMESPACE_BEGIN(CryptoPP)
 namespace Weak1 {
 
 //! \class ARC4_Base
-//! \brief Class specific methods used to operate the cipher.
+//! \brief ARC4 base class
 //! \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions
+//! \since Crypto++ 1.0
 class CRYPTOPP_NO_VTABLE ARC4_Base : public VariableKeyLength<16, 1, 256>, public RandomNumberGenerator, public SymmetricCipher, public SymmetricCipherDocumentation
 {
 public:
@@ -45,11 +46,14 @@ protected:
     byte m_x, m_y;
 };
 
-//! <a href="http://www.weidai.com/scan-mirror/cs.html#RC4">Alleged RC4</a>
+//! \class ARC4
+//! \brief Alleged RC4
+//! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#RC4">Alleged RC4</a>
+//! \since Crypto++ 1.0
 DOCUMENTED_TYPEDEF(SymmetricCipherFinal<ARC4_Base>, ARC4)
 
 //! \class MARC4_Base
-//! \brief Class specific methods used to operate the cipher.
+//! \brief MARC4 base class
 //! \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions
 //! \details MARC4 discards the first 256 bytes of keystream, which may be weaker than the rest
 class CRYPTOPP_NO_VTABLE MARC4_Base : public ARC4_Base
@@ -64,6 +68,10 @@ protected:
 	unsigned int GetDefaultDiscardBytes() const {return 256;}
 };
 
+//! \class MARC4
+//! \brief Modified Alleged RC4
+//! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#RC4">Alleged RC4</a>
+//! \since Crypto++ 1.0
 DOCUMENTED_TYPEDEF(SymmetricCipherFinal<MARC4_Base>, MARC4)
 
 }
-- 
cgit v1.2.1