Cleared issues 11,12,13 (Clang integrated assembler), 58 (RC rollup), 66 (Coverity rollup)

1 files changed, 24 insertions, 3 deletions

diff --git a/eax.h b/eax.h
index 128d0790..c9e3cf4e 100644
--- a/eax.h
+++ b/eax.h
@@ -1,3 +1,9 @@
+// eax.h - written and placed in the public domain by Wei Dai

+

+//! \file

+//! \headerfile eax.h

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

+

 #ifndef CRYPTOPP_EAX_H

 #define CRYPTOPP_EAX_H

 

@@ -7,7 +13,9 @@
 

 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

 class CRYPTOPP_NO_VTABLE EAX_Base : public AuthenticatedSymmetricCipherBase

 {

 public:

@@ -59,7 +67,13 @@ protected:
 	CTR_Mode_ExternalCipher::Encryption m_ctr;

 };

 

-//! .

+//! \class EAX_Final

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

+//! \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

 {

@@ -78,7 +92,14 @@ private:
 #undef EAX

 #endif

 

-/// <a href="http://www.cryptolounge.org/wiki/EAX">EAX</a>

+//! \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.

+//! \tparam T_BlockCipher block cipher

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

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

 template <class T_BlockCipher>

 struct EAX : public AuthenticatedSymmetricCipherDocumentation

 {