Updated documentation

1 files changed, 16 insertions, 4 deletions

diff --git a/ccm.h b/ccm.h
index 65d5287f..87596bee 100644
--- a/ccm.h
+++ b/ccm.h
@@ -1,7 +1,6 @@
 // ccm.h - written and placed in the public domain by Wei Dai

 

-//! \file

-//! \headerfile ccm.h

+//! \file ccm.h

 //! \brief CCM block cipher mode of operation

 

 #ifndef CRYPTOPP_CCM_H

@@ -12,6 +11,9 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

+//! \class CCM_Base

+//! \brief CCM block cipher base implementation

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

 class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CCM_Base : public AuthenticatedSymmetricCipherBase

 {

 public:

@@ -77,6 +79,11 @@ protected:
 	CTR_Mode_ExternalCipher::Encryption m_ctr;

 };

 

+//! \class CCM_Final

+//! \brief CCM block cipher final implementation

+//! \tparam T_BlockCipher block cipher

+//! \tparam T_DefaultDigestSize default digest size, in bytes

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

 template <class T_BlockCipher, int T_DefaultDigestSize, bool T_IsEncryption>

 class CCM_Final : public CCM_Base

 {

@@ -92,8 +99,13 @@ private:
 	typename T_BlockCipher::Encryption m_cipher;

 };

 

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

-//! \brief CCM mode of operation

+//! \class CCM

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

+//! \tparam T_BlockCipher block cipher

+//! \tparam T_DefaultDigestSize default digest size, in bytes

+//! \details \p CCM provides the \p Encryption and \p Decryption typedef. See GCM_Base

+//!   and GCM_Final for the AuthenticatedSymmetricCipher implementation.

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

 template <class T_BlockCipher, int T_DefaultDigestSize = 16>

 struct CCM : public AuthenticatedSymmetricCipherDocumentation

 {