Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
noloader committed Jan 29, 2016
1 parent b6a32c0 commit f8ff9e2
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 18 deletions.
20 changes: 16 additions & 4 deletions ccm.h
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -77,6 +79,11 @@ class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CCM_Base : public AuthenticatedSymmetricCi
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
{
Expand All @@ -92,8 +99,13 @@ class CCM_Final : public CCM_Base
typename T_BlockCipher::Encryption m_cipher;
};

/// <a href="http:https://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:https://www.cryptolounge.org/wiki/CCM">CCM</a> at the Crypto Lounge
template <class T_BlockCipher, int T_DefaultDigestSize = 16>
struct CCM : public AuthenticatedSymmetricCipherDocumentation
{
Expand Down
20 changes: 7 additions & 13 deletions eax.h
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -68,12 +67,9 @@ class CRYPTOPP_NO_VTABLE EAX_Base : public AuthenticatedSymmetricCipherBase
};

//! \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
{
Expand All @@ -93,12 +89,10 @@ class EAX_Final : public EAX_Base
#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:https://www.cryptolounge.org/wiki/EAX">EAX</a> at the Crypto Lounge
template <class T_BlockCipher>
struct EAX : public AuthenticatedSymmetricCipherDocumentation
Expand Down
3 changes: 2 additions & 1 deletion gcm.h
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ class GCM_Final : public GCM_Base
//! \brief GCM block cipher mode of operation
//! \tparam T_BlockCipher block cipher
//! \tparam T_TablesOption table size, either \p GCM_2K_Tables or \p GCM_64K_Tables
//! \details \p GCM provides the \p Encryption and \p Decryption typedef.
//! \details \p GCM provides the \p Encryption and \p Decryption typedef. See GCM_Base
//! and GCM_Final for the AuthenticatedSymmetricCipher implementation.
//! \sa <a href="http:https://www.cryptolounge.org/wiki/GCM">GCM</a> at the Crypto Lounge
template <class T_BlockCipher, GCM_TablesOption T_TablesOption=GCM_2K_Tables>
struct GCM : public AuthenticatedSymmetricCipherDocumentation
Expand Down

0 comments on commit f8ff9e2

Please sign in to comment.