Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
noloader committed Sep 11, 2016
1 parent d28d6e0 commit d8f9175
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 0 deletions.
2 changes: 2 additions & 0 deletions authenc.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
//! \file
//! \headerfile authenc.h
//! \brief Base classes for working with authenticated encryption modes of encryption
//! \since Crypto++ 5.6.0

#ifndef CRYPTOPP_AUTHENC_H
#define CRYPTOPP_AUTHENC_H
Expand All @@ -14,6 +15,7 @@ NAMESPACE_BEGIN(CryptoPP)

//! \class AuthenticatedSymmetricCipherBase
//! \brief Base implementation for one direction (encryption or decryption) of a stream cipher or block cipher mode with authentication
//! \since Crypto++ 5.6.0
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE AuthenticatedSymmetricCipherBase : public AuthenticatedSymmetricCipher
{
public:
Expand Down
4 changes: 4 additions & 0 deletions ccm.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

//! \file ccm.h
//! \brief CCM block cipher mode of operation
//! \since Crypto++ 5.6.0

#ifndef CRYPTOPP_CCM_H
#define CRYPTOPP_CCM_H
Expand All @@ -14,6 +15,7 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class CCM_Base
//! \brief CCM block cipher base implementation
//! \details Base implementation of the AuthenticatedSymmetricCipher interface
//! \since Crypto++ 5.6.0
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CCM_Base : public AuthenticatedSymmetricCipherBase
{
public:
Expand Down Expand Up @@ -84,6 +86,7 @@ class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CCM_Base : public AuthenticatedSymmetricCi
//! \tparam T_BlockCipher block cipher
//! \tparam T_DefaultDigestSize default digest size, in bytes
//! \tparam T_IsEncryption direction in which to operate the cipher
//! \since Crypto++ 5.6.0
template <class T_BlockCipher, int T_DefaultDigestSize, bool T_IsEncryption>
class CCM_Final : public CCM_Base
{
Expand All @@ -106,6 +109,7 @@ class CCM_Final : public CCM_Base
//! \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
//! \since Crypto++ 5.6.0
template <class T_BlockCipher, int T_DefaultDigestSize = 16>
struct CCM : public AuthenticatedSymmetricCipherDocumentation
{
Expand Down
3 changes: 3 additions & 0 deletions cmac.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

//! \file cmac.h
//! \brief Classes for CMAC message authentication code
//! \since Crypto++ 5.6.0

#ifndef CRYPTOPP_CMAC_H
#define CRYPTOPP_CMAC_H
Expand All @@ -13,6 +14,7 @@ NAMESPACE_BEGIN(CryptoPP)

//! \class CMAC_Base
//! \brief CMAC base implementation
//! \since Crypto++ 5.6.0
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CMAC_Base : public MessageAuthenticationCode
{
public:
Expand Down Expand Up @@ -40,6 +42,7 @@ class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CMAC_Base : public MessageAuthenticationCo
//! \tparam T block cipher
//! \details Template parameter T should be a class derived from BlockCipherDocumentation, for example AES, with a block size of 8, 16, or 32.
//! \sa <a href="http:https://www.cryptolounge.org/wiki/CMAC">CMAC</a>
//! \since Crypto++ 5.6.0
template <class T>
class CMAC : public MessageAuthenticationCodeImpl<CMAC_Base, CMAC<T> >, public SameKeyLengthAs<T>
{
Expand Down
3 changes: 3 additions & 0 deletions eax.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class EAX_Base
//! \brief EAX block cipher base implementation
//! \details Base implementation of the AuthenticatedSymmetricCipher interface
//! \since Crypto++ 5.6.0
class CRYPTOPP_NO_VTABLE EAX_Base : public AuthenticatedSymmetricCipherBase
{
public:
Expand Down Expand Up @@ -70,6 +71,7 @@ class CRYPTOPP_NO_VTABLE EAX_Base : public AuthenticatedSymmetricCipherBase
//! \brief EAX block cipher final implementation
//! \tparam T_BlockCipher block cipher
//! \tparam T_IsEncryption direction in which to operate the cipher
//! \since Crypto++ 5.6.0
template <class T_BlockCipher, bool T_IsEncryption>
class EAX_Final : public EAX_Base
{
Expand All @@ -94,6 +96,7 @@ class EAX_Final : public EAX_Base
//! \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
//! \since Crypto++ 5.6.0
template <class T_BlockCipher>
struct EAX : public AuthenticatedSymmetricCipherDocumentation
{
Expand Down
4 changes: 4 additions & 0 deletions gcm.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

//! \file gcm.h
//! \brief GCM block cipher mode of operation
//! \since Crypto++ 5.6.0

#ifndef CRYPTOPP_GCM_H
#define CRYPTOPP_GCM_H
Expand All @@ -22,6 +23,7 @@ enum GCM_TablesOption {
//! \class GCM_Base
//! \brief GCM block cipher base implementation
//! \details Base implementation of the AuthenticatedSymmetricCipher interface
//! \since Crypto++ 5.6.0
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE GCM_Base : public AuthenticatedSymmetricCipherBase
{
public:
Expand Down Expand Up @@ -94,6 +96,7 @@ class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE GCM_Base : public AuthenticatedSymmetricCi
//! \tparam T_BlockCipher block cipher
//! \tparam T_TablesOption table size, either \p GCM_2K_Tables or \p GCM_64K_Tables
//! \tparam T_IsEncryption direction in which to operate the cipher
//! \since Crypto++ 5.6.0
template <class T_BlockCipher, GCM_TablesOption T_TablesOption, bool T_IsEncryption>
class GCM_Final : public GCM_Base
{
Expand All @@ -116,6 +119,7 @@ class GCM_Final : public GCM_Base
//! \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
//! \since Crypto++ 5.6.0
template <class T_BlockCipher, GCM_TablesOption T_TablesOption=GCM_2K_Tables>
struct GCM : public AuthenticatedSymmetricCipherDocumentation
{
Expand Down
3 changes: 3 additions & 0 deletions seed.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

//! \file seed.h
//! \brief Classes for the SEED block cipher
//! \since Crypto++ 5.6.0

#ifndef CRYPTOPP_SEED_H
#define CRYPTOPP_SEED_H
Expand All @@ -13,6 +14,7 @@ NAMESPACE_BEGIN(CryptoPP)

//! \class SEED_Info
//! \brief SEED block cipher information
//! \since Crypto++ 5.6.0
struct SEED_Info : public FixedBlockSize<16>, public FixedKeyLength<16>, public FixedRounds<16>
{
CRYPTOPP_CONSTEXPR static const char *StaticAlgorithmName() {return "SEED";}
Expand All @@ -21,6 +23,7 @@ struct SEED_Info : public FixedBlockSize<16>, public FixedKeyLength<16>, public
//! \class SEED
//! \brief SEED block cipher
//! \sa <a href="http:https://www.cryptolounge.org/wiki/SEED">SEED</a>
//! \since Crypto++ 5.6.0
class SEED : public SEED_Info, public BlockCipherDocumentation
{
class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<SEED_Info>
Expand Down

0 comments on commit d8f9175

Please sign in to comment.