Updated documentation

1 files changed, 7 insertions, 13 deletions

diff --git a/eax.h b/eax.h
index c9e3cf4e..178522bc 100644
--- a/eax.h
+++ b/eax.h
@@ -1,7 +1,6 @@
 // eax.h - written and placed in the public domain by Wei Dai

 

-//! \file

-//! \headerfile eax.h

+//! \file eax.h

 //! \brief EAX block cipher mode of operation

 

 #ifndef CRYPTOPP_EAX_H

@@ -14,8 +13,8 @@
 NAMESPACE_BEGIN(CryptoPP)

 

 //! \class EAX_Base

-//! \brief EAX block cipher mode of operation

-//! \details Implementations and overrides in \p EAX_Base apply to both \p ENCRYPTION and \p DECRYPTION directions

+//! \brief EAX block cipher base implementation

+//! \details Base implementation of the AuthenticatedSymmetricCipher interface

 class CRYPTOPP_NO_VTABLE EAX_Base : public AuthenticatedSymmetricCipherBase

 {

 public:

@@ -68,12 +67,9 @@ protected:
 };

 

 //! \class EAX_Final

-//! \brief Class specific methods used to operate the cipher.

+//! \brief EAX block cipher final implementation

 //! \tparam T_BlockCipher block cipher

 //! \tparam T_IsEncryption direction in which to operate the cipher

-//! \details Implementations and overrides in \p GCM_Final apply to either

-//!   \p ENCRYPTION or \p DECRYPTION, depending on the template parameter \p T_IsEncryption.

-//! \details \p EAX_Final does not use inner classes \p Enc and \p Dec.

 template <class T_BlockCipher, bool T_IsEncryption>

 class EAX_Final : public EAX_Base

 {

@@ -93,12 +89,10 @@ private:
 #endif

 

 //! \class EAX

-//! \brief The EAX block cipher mode of operation

-//! \details EAX is an Authenticated Encryption with Associated Data (AEAD) block

-//!   cipher mode of operation designed to simultaneously provide both authentication

-//!   and privacy of the message.

+//! \brief EAX block cipher mode of operation

 //! \tparam T_BlockCipher block cipher

-//! \details \p EAX provides the \p Encryption and \p Decryption typedef.

+//! \details \p EAX provides the \p Encryption and \p Decryption typedef. See EAX_Base

+//!   and EAX_Final for the AuthenticatedSymmetricCipher implementation.

 //! \sa <a href="http://www.cryptolounge.org/wiki/EAX">EAX</a> at the Crypto Lounge

 template <class T_BlockCipher>

 struct EAX : public AuthenticatedSymmetricCipherDocumentation