Skip to content

Commit befd043

Browse files
committed
Remove unneeded Doxygen directive
1 parent 24a9466 commit befd043

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+0
-568
lines changed

3way.h

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,16 @@
1212

1313
NAMESPACE_BEGIN(CryptoPP)
1414

15-
/// \class ThreeWay_Info
1615
/// \brief ThreeWay block cipher information
1716
struct ThreeWay_Info : public FixedBlockSize<12>, public FixedKeyLength<12>, public VariableRounds<11>
1817
{
1918
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "3-Way";}
2019
};
2120

22-
/// \class ThreeWay
2321
/// \brief ThreeWay block cipher
2422
/// \sa <a href="http://www.cryptopp.com/wiki/3-Way">3-Way</a>
2523
class ThreeWay : public ThreeWay_Info, public BlockCipherDocumentation
2624
{
27-
/// \class Base
2825
/// \brief Class specific implementation and overrides used to operate the cipher.
2926
/// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions
3027
class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<ThreeWay_Info>
@@ -37,7 +34,6 @@ class ThreeWay : public ThreeWay_Info, public BlockCipherDocumentation
3734
FixedSizeSecBlock<word32, 3> m_k;
3835
};
3936

40-
/// \class Enc
4137
/// \brief Class specific methods used to operate the cipher in the forward direction.
4238
/// \details Implementations and overrides in \p Enc apply to \p ENCRYPTION.
4339
class CRYPTOPP_NO_VTABLE Enc : public Base
@@ -46,7 +42,6 @@ class ThreeWay : public ThreeWay_Info, public BlockCipherDocumentation
4642
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
4743
};
4844

49-
/// \class Dec
5045
/// \brief Class specific methods used to operate the cipher in the reverse direction.
5146
/// \details Implementations and overrides in \p Dec apply to \p DECRYPTION.
5247
class CRYPTOPP_NO_VTABLE Dec : public Base

aes.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414

1515
NAMESPACE_BEGIN(CryptoPP)
1616

17-
/// \class AES
1817
/// \brief AES block cipher (Rijndael)
1918
/// \details AES is a typdef for Rijndael classes. All key sizes are supported.
2019
/// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks

algparam.h

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626

2727
NAMESPACE_BEGIN(CryptoPP)
2828

29-
/// \class ConstByteArrayParameter
3029
/// \brief Used to pass byte array input as part of a NameValuePairs object
3130
class ConstByteArrayParameter
3231
{
@@ -101,7 +100,6 @@ class ConstByteArrayParameter
101100
SecByteBlock m_block;
102101
};
103102

104-
/// \class ByteArrayParameter
105103
/// \brief Used to pass byte array input as part of a NameValuePairs object
106104
class ByteArrayParameter
107105
{
@@ -129,7 +127,6 @@ class ByteArrayParameter
129127
size_t m_size;
130128
};
131129

132-
/// \class CombinedNameValuePairs
133130
/// \brief Combines two sets of NameValuePairs
134131
/// \details CombinedNameValuePairs allows you to provide two sets of of NameValuePairs.
135132
/// If a name is not found in the first set, then the second set is searched for the
@@ -308,12 +305,10 @@ CRYPTOPP_DLL bool AssignIntToInteger(const std::type_info &valueType, void *pInt
308305

309306
CRYPTOPP_DLL const std::type_info & CRYPTOPP_API IntegerTypeId();
310307

311-
/// \class AlgorithmParametersBase
312308
/// \brief Base class for AlgorithmParameters
313309
class CRYPTOPP_DLL AlgorithmParametersBase
314310
{
315311
public:
316-
/// \class ParameterNotUsed
317312
/// \brief Exception thrown when an AlgorithmParameter is unused
318313
class ParameterNotUsed : public Exception
319314
{
@@ -370,7 +365,6 @@ class CRYPTOPP_DLL AlgorithmParametersBase
370365
member_ptr<AlgorithmParametersBase> m_next;
371366
};
372367

373-
/// \class AlgorithmParametersTemplate
374368
/// \brief Template base class for AlgorithmParameters
375369
/// \tparam T the class or type
376370
template <class T>
@@ -423,7 +417,6 @@ CRYPTOPP_DLL_TEMPLATE_CLASS AlgorithmParametersTemplate<bool>;
423417
CRYPTOPP_DLL_TEMPLATE_CLASS AlgorithmParametersTemplate<int>;
424418
CRYPTOPP_DLL_TEMPLATE_CLASS AlgorithmParametersTemplate<ConstByteArrayParameter>;
425419

426-
/// \class AlgorithmParameters
427420
/// \brief An object that implements NameValuePairs
428421
/// \note A NameValuePairs object containing an arbitrary number of name value pairs may be constructed by
429422
/// repeatedly using operator() on the object returned by MakeParameters, for example:

arc4.h

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ NAMESPACE_BEGIN(CryptoPP)
1515

1616
namespace Weak1 {
1717

18-
/// \class ARC4_Base
1918
/// \brief ARC4 base class
2019
/// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions
2120
/// \since Crypto++ 1.0
@@ -46,13 +45,11 @@ class CRYPTOPP_NO_VTABLE ARC4_Base : public VariableKeyLength<16, 1, 256>, publi
4645
byte m_x, m_y;
4746
};
4847

49-
/// \class ARC4
5048
/// \brief Alleged RC4
5149
/// \sa <a href="http://www.cryptopp.com/wiki/RC4">Alleged RC4</a>
5250
/// \since Crypto++ 1.0
5351
DOCUMENTED_TYPEDEF(SymmetricCipherFinal<ARC4_Base>, ARC4)
5452

55-
/// \class MARC4_Base
5653
/// \brief MARC4 base class
5754
/// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions
5855
/// \details MARC4 discards the first 256 bytes of keystream, which may be weaker than the rest
@@ -68,7 +65,6 @@ class CRYPTOPP_NO_VTABLE MARC4_Base : public ARC4_Base
6865
unsigned int GetDefaultDiscardBytes() const {return 256;}
6966
};
7067

71-
/// \class MARC4
7268
/// \brief Modified Alleged RC4
7369
/// \sa <a href="http://www.cryptopp.com/wiki/RC4">Alleged RC4</a>
7470
/// \since Crypto++ 1.0

aria.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,13 @@
1919

2020
NAMESPACE_BEGIN(CryptoPP)
2121

22-
/// \class ARIA_Info
2322
/// \brief ARIA block cipher information
2423
/// \since Crypto++ 6.0
2524
struct ARIA_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 8>
2625
{
2726
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "ARIA";}
2827
};
2928

30-
/// \class ARIA
3129
/// \brief ARIA block cipher
3230
/// \details The Crypto++ ARIA implementation is based on the 32-bit implementation by Aaram Yun
3331
/// from the National Security Research Institute, KOREA. Aaram Yun's implementation is based on

authenc.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525

2626
NAMESPACE_BEGIN(CryptoPP)
2727

28-
/// \class AuthenticatedSymmetricCipherBase
2928
/// \brief Base class for authenticated encryption modes of operation
3029
/// \details AuthenticatedSymmetricCipherBase() serves as a base implementation for one direction
3130
/// (encryption or decryption) of a stream cipher or block cipher mode with authentication.

base32.h

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212

1313
NAMESPACE_BEGIN(CryptoPP)
1414

15-
/// \class Base32Encoder
1615
/// \brief Base32 encodes data using DUDE encoding
1716
/// \details Converts data to base32 using DUDE encoding. The default code is based on <A HREF="http://www.ietf.org/proceedings/51/I-D/draft-ietf-idn-dude-02.txt">Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt)</A>.
1817
/// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder
@@ -57,7 +56,6 @@ class Base32Encoder : public SimpleProxyFilter
5756
void IsolatedInitialize(const NameValuePairs &parameters);
5857
};
5958

60-
/// \class Base32Decoder
6159
/// \brief Base32 decodes data using DUDE encoding
6260
/// \details Converts data from base32 using DUDE encoding. The default code is based on <A HREF="http://www.ietf.org/proceedings/51/I-D/draft-ietf-idn-dude-02.txt">Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt)</A>.
6361
/// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder
@@ -94,7 +92,6 @@ class Base32Decoder : public BaseN_Decoder
9492
static const int * CRYPTOPP_API GetDefaultDecodingLookupArray();
9593
};
9694

97-
/// \class Base32HexEncoder
9895
/// \brief Base32 encodes data using extended hex
9996
/// \details Converts data to base32 using extended hex alphabet. The alphabet is different than Base32Encoder.
10097
/// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, <A HREF="http://tools.ietf.org/html/rfc4648#page-10">RFC 4648, Base 32 Encoding with Extended Hex Alphabet</A>.
@@ -130,7 +127,6 @@ class Base32HexEncoder : public SimpleProxyFilter
130127
void IsolatedInitialize(const NameValuePairs &parameters);
131128
};
132129

133-
/// \class Base32HexDecoder
134130
/// \brief Base32 decodes data using extended hex
135131
/// \details Converts data from base32 using extended hex alphabet. The alphabet is different than Base32Decoder.
136132
/// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, <A HREF="http://tools.ietf.org/html/rfc4648#page-10">RFC 4648, Base 32 Encoding with Extended Hex Alphabet</A>.

base64.h

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111

1212
NAMESPACE_BEGIN(CryptoPP)
1313

14-
/// \class Base64Encoder
1514
/// \brief Base64 encodes data using DUDE
1615
/// \details Base64 encodes data per <A HREF="http://tools.ietf.org/html/rfc4648#section-4">RFC 4648, Base 64 Encoding</A>.
1716
class Base64Encoder : public SimpleProxyFilter
@@ -53,7 +52,6 @@ class Base64Encoder : public SimpleProxyFilter
5352
void IsolatedInitialize(const NameValuePairs &parameters);
5453
};
5554

56-
/// \class Base64Decoder
5755
/// \brief Base64 decodes data using DUDE
5856
/// \details Base64 encodes data per <A HREF="http://tools.ietf.org/html/rfc4648#section-4">RFC 4648, Base 64 Encoding</A>.
5957
class Base64Decoder : public BaseN_Decoder
@@ -90,7 +88,6 @@ class Base64Decoder : public BaseN_Decoder
9088
static const int * CRYPTOPP_API GetDecodingLookupArray();
9189
};
9290

93-
/// \class Base64URLEncoder
9491
/// \brief Base64 encodes data using a web safe alphabet
9592
/// \details Base64 encodes data per <A HREF="http://tools.ietf.org/html/rfc4648#section-5">RFC 4648, Base 64 Encoding
9693
/// with URL and Filename Safe Alphabet</A>.
@@ -128,7 +125,6 @@ class Base64URLEncoder : public SimpleProxyFilter
128125
void IsolatedInitialize(const NameValuePairs &parameters);
129126
};
130127

131-
/// \class Base64URLDecoder
132128
/// \brief Base64 decodes data using a web safe alphabet
133129
/// \details Base64 encodes data per <A HREF="http://tools.ietf.org/html/rfc4648#section-5">RFC 4648, Base 64 Encoding
134130
/// with URL and Filename Safe Alphabet</A>.

basecode.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313

1414
NAMESPACE_BEGIN(CryptoPP)
1515

16-
/// \class BaseN_Encoder
1716
/// \brief Encoder for bases that are a power of 2
1817
class CRYPTOPP_DLL BaseN_Encoder : public Unflushable<Filter>
1918
{
@@ -53,7 +52,6 @@ class CRYPTOPP_DLL BaseN_Encoder : public Unflushable<Filter>
5352
SecByteBlock m_outBuf;
5453
};
5554

56-
/// \class BaseN_Decoder
5755
/// \brief Decoder for bases that are a power of 2
5856
class CRYPTOPP_DLL BaseN_Decoder : public Unflushable<Filter>
5957
{
@@ -105,7 +103,6 @@ class CRYPTOPP_DLL BaseN_Decoder : public Unflushable<Filter>
105103
SecByteBlock m_outBuf;
106104
};
107105

108-
/// \class Grouper
109106
/// \brief Filter that breaks input stream into groups of fixed size
110107
class CRYPTOPP_DLL Grouper : public Bufferless<Filter>
111108
{

blake2.h

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323

2424
NAMESPACE_BEGIN(CryptoPP)
2525

26-
/// \class BLAKE2_Info
2726
/// \brief BLAKE2 hash information
2827
/// \tparam T_64bit flag indicating 64-bit
2928
/// \since Crypto++ 5.6.4
@@ -43,7 +42,6 @@ struct BLAKE2_Info : public VariableKeyLength<(T_64bit ? 64 : 32),0,(T_64bit ? 6
4342
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return (T_64bit ? "BLAKE2b" : "BLAKE2s");}
4443
};
4544

46-
/// \class BLAKE2_ParameterBlock
4745
/// \brief BLAKE2 parameter block
4846
/// \tparam T_64bit flag indicating 64-bit
4947
/// \details BLAKE2b uses BLAKE2_ParameterBlock<true>, while BLAKE2s
@@ -124,7 +122,6 @@ struct CRYPTOPP_NO_VTABLE BLAKE2_ParameterBlock<false>
124122
byte personalization[PERSONALIZATIONSIZE];
125123
};
126124

127-
/// \class BLAKE2_State
128125
/// \brief BLAKE2 state information
129126
/// \tparam W word type
130127
/// \tparam T_64bit flag indicating 64-bit
@@ -150,7 +147,6 @@ struct CRYPTOPP_NO_VTABLE BLAKE2_State
150147
size_t length;
151148
};
152149

153-
/// \class BLAKE2_Base
154150
/// \brief BLAKE2 hash implementation
155151
/// \tparam W word type
156152
/// \tparam T_64bit flag indicating 64-bit

blowfish.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111

1212
NAMESPACE_BEGIN(CryptoPP)
1313

14-
/// \class Blowfish_Info
1514
/// \brief Blowfish block cipher information
1615
struct Blowfish_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 4, 56>, public FixedRounds<16>
1716
{
@@ -20,12 +19,10 @@ struct Blowfish_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 4,
2019

2120
// <a href="http://www.cryptopp.com/wiki/Blowfish">Blowfish</a>
2221

23-
/// \class Blowfish
2422
/// \brief Blowfish block cipher
2523
/// \since Crypto++ 1.0
2624
class Blowfish : public Blowfish_Info, public BlockCipherDocumentation
2725
{
28-
/// \class Base
2926
/// \brief Class specific implementation and overrides used to operate the cipher.
3027
/// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions
3128
class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<Blowfish_Info>

camellia.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,12 @@
1212

1313
NAMESPACE_BEGIN(CryptoPP)
1414

15-
/// \class Camellia_Info
1615
/// \brief Camellia block cipher information
1716
struct Camellia_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 8>
1817
{
1918
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "Camellia";}
2019
};
2120

22-
/// \class Camellia
2321
/// \brief Camellia block cipher
2422
/// \sa <a href="http://www.cryptopp.com/wiki/Camellia">Camellia</a>
2523
class Camellia : public Camellia_Info, public BlockCipherDocumentation

cast.h

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,23 @@
1111

1212
NAMESPACE_BEGIN(CryptoPP)
1313

14-
/// \class CAST
1514
/// \brief CAST block cipher base
1615
class CAST
1716
{
1817
protected:
1918
static const word32 S[8][256];
2019
};
2120

22-
/// \class CAST128_Info
2321
/// \brief CAST128 block cipher information
2422
struct CAST128_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 5, 16>
2523
{
2624
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "CAST-128";}
2725
};
2826

29-
/// \class CAST128
3027
/// \brief CAST128 block cipher
3128
/// \sa <a href="http://www.cryptopp.com/wiki/CAST-128">CAST-128</a>
3229
class CAST128 : public CAST128_Info, public BlockCipherDocumentation
3330
{
34-
/// \class Base
3531
/// \brief CAST128 block cipher default operation
3632
class CRYPTOPP_NO_VTABLE Base : public CAST, public BlockCipherImpl<CAST128_Info>
3733
{
@@ -43,15 +39,13 @@ class CAST128 : public CAST128_Info, public BlockCipherDocumentation
4339
FixedSizeSecBlock<word32, 32> K;
4440
};
4541

46-
/// \class Enc
4742
/// \brief CAST128 block cipher encryption operation
4843
class CRYPTOPP_NO_VTABLE Enc : public Base
4944
{
5045
public:
5146
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
5247
};
5348

54-
/// \class Dec
5549
/// \brief CAST128 block cipher decryption operation
5650
class CRYPTOPP_NO_VTABLE Dec : public Base
5751
{
@@ -64,19 +58,16 @@ class CAST128 : public CAST128_Info, public BlockCipherDocumentation
6458
typedef BlockCipherFinal<DECRYPTION, Dec> Decryption;
6559
};
6660

67-
/// \class CAST256_Info
6861
/// \brief CAST256 block cipher information
6962
struct CAST256_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 4>
7063
{
7164
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "CAST-256";}
7265
};
7366

74-
/// \class CAST256
7567
/// \brief CAST256 block cipher
7668
/// \sa <a href="http://www.cryptopp.com/wiki/CAST-256">CAST-256</a>
7769
class CAST256 : public CAST256_Info, public BlockCipherDocumentation
7870
{
79-
/// \class Base
8071
/// \brief CAST256 block cipher default operation
8172
class CRYPTOPP_NO_VTABLE Base : public CAST, public BlockCipherImpl<CAST256_Info>
8273
{

ccm.h

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212

1313
NAMESPACE_BEGIN(CryptoPP)
1414

15-
/// \class CCM_Base
1615
/// \brief CCM block cipher base implementation
1716
/// \details Base implementation of the AuthenticatedSymmetricCipher interface
1817
/// \since Crypto++ 5.6.0
@@ -81,7 +80,6 @@ class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CCM_Base : public AuthenticatedSymmetricCi
8180
CTR_Mode_ExternalCipher::Encryption m_ctr;
8281
};
8382

84-
/// \class CCM_Final
8583
/// \brief CCM block cipher final implementation
8684
/// \tparam T_BlockCipher block cipher
8785
/// \tparam T_DefaultDigestSize default digest size, in bytes
@@ -102,7 +100,6 @@ class CCM_Final : public CCM_Base
102100
typename T_BlockCipher::Encryption m_cipher;
103101
};
104102

105-
/// \class CCM
106103
/// \brief CCM block cipher mode of operation
107104
/// \tparam T_BlockCipher block cipher
108105
/// \tparam T_DefaultDigestSize default digest size, in bytes

0 commit comments

Comments
 (0)