From befd04312d8bdf2363921bf5ccb1393f5852a9a3 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Fri, 19 Jan 2018 14:31:20 -0500 Subject: [PATCH] Remove unneeded Doxygen directive --- 3way.h | 5 ----- aes.h | 1 - algparam.h | 7 ------- arc4.h | 4 ---- aria.h | 2 -- authenc.h | 1 - base32.h | 4 ---- base64.h | 4 ---- basecode.h | 3 --- blake2.h | 4 ---- blowfish.h | 3 --- camellia.h | 2 -- cast.h | 9 --------- ccm.h | 3 --- chacha.h | 5 ----- cmac.h | 1 - cryptlib.cpp | 1 - cryptlib.h | 26 -------------------------- default.h | 16 ---------------- des.h | 13 ------------- dh.h | 1 - dh2.h | 1 - dmac.h | 2 -- drbg.h | 3 --- eax.h | 3 --- ec2n.h | 3 --- eccrypto.h | 20 -------------------- ecp.h | 3 --- ecpoint.h | 3 --- elgamal.h | 4 ---- emsa2.h | 4 ---- esign.h | 6 ------ factory.h | 4 ---- files.h | 3 --- filters.h | 32 -------------------------------- fips140.h | 1 - gcm.h | 3 --- gfpcrypt.h | 20 -------------------- gost.h | 5 ----- gzip.h | 6 ------ hex.h | 2 -- hmac.h | 2 -- hrtimer.h | 2 -- ida.h | 5 ----- idea.h | 2 -- iterhash.h | 4 ---- kalyna.h | 4 ---- keccak.h | 2 -- lubyrack.h | 2 -- luc.h | 4 ---- mars.h | 2 -- md5.h | 1 - mdc.h | 2 -- mersenne.h | 3 --- misc.h | 9 --------- modarith.h | 2 -- modes.h | 29 ----------------------------- mqv.h | 1 - nbtheory.h | 2 -- osrng.h | 7 ------- panama.h | 6 ------ pkcspad.h | 3 --- poly1305.h | 2 -- pubkey.h | 37 ------------------------------------- queue.h | 2 -- rabin.h | 2 -- randpool.h | 2 -- rc2.h | 7 ------- rc5.h | 2 -- rc6.h | 2 -- ripemd.h | 4 ---- rng.h | 2 -- rsa.h | 9 --------- rw.h | 2 -- safer.h | 9 --------- salsa.h | 6 ------ seal.h | 3 --- secblock.h | 11 ----------- seckey.h | 14 -------------- seed.h | 2 -- serpent.h | 2 -- sha.h | 5 ----- sha3.h | 2 -- shacal2.h | 2 -- shark.h | 5 ----- simon.h | 4 ---- simple.h | 17 ----------------- siphash.h | 3 --- skipjack.h | 5 ----- sm3.h | 1 - sm4.h | 2 -- smartptr.h | 7 ------- sosemanuk.h | 3 --- speck.h | 4 ---- square.h | 2 -- strciphr.h | 12 ------------ tea.h | 15 --------------- threefish.h | 5 ----- ttmac.h | 2 -- twofish.h | 2 -- vmac.h | 2 -- wake.h | 3 --- xtr.h | 2 -- zdeflate.h | 3 --- zinflate.h | 3 --- 105 files changed, 568 deletions(-) diff --git a/3way.h b/3way.h index 19d2ff63..5e275fd7 100644 --- a/3way.h +++ b/3way.h @@ -12,19 +12,16 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ThreeWay_Info /// \brief ThreeWay block cipher information struct ThreeWay_Info : public FixedBlockSize<12>, public FixedKeyLength<12>, public VariableRounds<11> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "3-Way";} }; -/// \class ThreeWay /// \brief ThreeWay block cipher /// \sa 3-Way class ThreeWay : public ThreeWay_Info, public BlockCipherDocumentation { - /// \class Base /// \brief Class specific implementation and overrides used to operate the cipher. /// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl @@ -37,7 +34,6 @@ class ThreeWay : public ThreeWay_Info, public BlockCipherDocumentation FixedSizeSecBlock m_k; }; - /// \class Enc /// \brief Class specific methods used to operate the cipher in the forward direction. /// \details Implementations and overrides in \p Enc apply to \p ENCRYPTION. class CRYPTOPP_NO_VTABLE Enc : public Base @@ -46,7 +42,6 @@ class ThreeWay : public ThreeWay_Info, public BlockCipherDocumentation void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; - /// \class Dec /// \brief Class specific methods used to operate the cipher in the reverse direction. /// \details Implementations and overrides in \p Dec apply to \p DECRYPTION. class CRYPTOPP_NO_VTABLE Dec : public Base diff --git a/aes.h b/aes.h index 8a76ca24..438d6526 100644 --- a/aes.h +++ b/aes.h @@ -14,7 +14,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class AES /// \brief AES block cipher (Rijndael) /// \details AES is a typdef for Rijndael classes. All key sizes are supported. /// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks diff --git a/algparam.h b/algparam.h index 8cbb736e..fcdd7f86 100644 --- a/algparam.h +++ b/algparam.h @@ -26,7 +26,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ConstByteArrayParameter /// \brief Used to pass byte array input as part of a NameValuePairs object class ConstByteArrayParameter { @@ -101,7 +100,6 @@ private: SecByteBlock m_block; }; -/// \class ByteArrayParameter /// \brief Used to pass byte array input as part of a NameValuePairs object class ByteArrayParameter { @@ -129,7 +127,6 @@ private: size_t m_size; }; -/// \class CombinedNameValuePairs /// \brief Combines two sets of NameValuePairs /// \details CombinedNameValuePairs allows you to provide two sets of of NameValuePairs. /// 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 CRYPTOPP_DLL const std::type_info & CRYPTOPP_API IntegerTypeId(); -/// \class AlgorithmParametersBase /// \brief Base class for AlgorithmParameters class CRYPTOPP_DLL AlgorithmParametersBase { public: - /// \class ParameterNotUsed /// \brief Exception thrown when an AlgorithmParameter is unused class ParameterNotUsed : public Exception { @@ -370,7 +365,6 @@ protected: member_ptr m_next; }; -/// \class AlgorithmParametersTemplate /// \brief Template base class for AlgorithmParameters /// \tparam T the class or type template @@ -423,7 +417,6 @@ CRYPTOPP_DLL_TEMPLATE_CLASS AlgorithmParametersTemplate; CRYPTOPP_DLL_TEMPLATE_CLASS AlgorithmParametersTemplate; CRYPTOPP_DLL_TEMPLATE_CLASS AlgorithmParametersTemplate; -/// \class AlgorithmParameters /// \brief An object that implements NameValuePairs /// \note A NameValuePairs object containing an arbitrary number of name value pairs may be constructed by /// repeatedly using operator() on the object returned by MakeParameters, for example: diff --git a/arc4.h b/arc4.h index 22a8f9e0..a5b20da6 100644 --- a/arc4.h +++ b/arc4.h @@ -15,7 +15,6 @@ NAMESPACE_BEGIN(CryptoPP) namespace Weak1 { -/// \class ARC4_Base /// \brief ARC4 base class /// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions /// \since Crypto++ 1.0 @@ -46,13 +45,11 @@ protected: byte m_x, m_y; }; -/// \class ARC4 /// \brief Alleged RC4 /// \sa Alleged RC4 /// \since Crypto++ 1.0 DOCUMENTED_TYPEDEF(SymmetricCipherFinal, ARC4) -/// \class MARC4_Base /// \brief MARC4 base class /// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions /// \details MARC4 discards the first 256 bytes of keystream, which may be weaker than the rest @@ -68,7 +65,6 @@ protected: unsigned int GetDefaultDiscardBytes() const {return 256;} }; -/// \class MARC4 /// \brief Modified Alleged RC4 /// \sa Alleged RC4 /// \since Crypto++ 1.0 diff --git a/aria.h b/aria.h index e4eaee99..ca3f3b81 100644 --- a/aria.h +++ b/aria.h @@ -19,7 +19,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ARIA_Info /// \brief ARIA block cipher information /// \since Crypto++ 6.0 struct ARIA_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 8> @@ -27,7 +26,6 @@ struct ARIA_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 3 CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "ARIA";} }; -/// \class ARIA /// \brief ARIA block cipher /// \details The Crypto++ ARIA implementation is based on the 32-bit implementation by Aaram Yun /// from the National Security Research Institute, KOREA. Aaram Yun's implementation is based on diff --git a/authenc.h b/authenc.h index 6ff87cf2..236ff21d 100644 --- a/authenc.h +++ b/authenc.h @@ -25,7 +25,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class AuthenticatedSymmetricCipherBase /// \brief Base class for authenticated encryption modes of operation /// \details AuthenticatedSymmetricCipherBase() serves as a base implementation for one direction /// (encryption or decryption) of a stream cipher or block cipher mode with authentication. diff --git a/base32.h b/base32.h index f3318495..4eeae43c 100644 --- a/base32.h +++ b/base32.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Base32Encoder /// \brief Base32 encodes data using DUDE encoding /// \details Converts data to base32 using DUDE encoding. The default code is based on Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt). /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder @@ -57,7 +56,6 @@ public: void IsolatedInitialize(const NameValuePairs ¶meters); }; -/// \class Base32Decoder /// \brief Base32 decodes data using DUDE encoding /// \details Converts data from base32 using DUDE encoding. The default code is based on Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt). /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder @@ -94,7 +92,6 @@ private: static const int * CRYPTOPP_API GetDefaultDecodingLookupArray(); }; -/// \class Base32HexEncoder /// \brief Base32 encodes data using extended hex /// \details Converts data to base32 using extended hex alphabet. The alphabet is different than Base32Encoder. /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, RFC 4648, Base 32 Encoding with Extended Hex Alphabet. @@ -130,7 +127,6 @@ public: void IsolatedInitialize(const NameValuePairs ¶meters); }; -/// \class Base32HexDecoder /// \brief Base32 decodes data using extended hex /// \details Converts data from base32 using extended hex alphabet. The alphabet is different than Base32Decoder. /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, RFC 4648, Base 32 Encoding with Extended Hex Alphabet. diff --git a/base64.h b/base64.h index a230f1ea..5defc374 100644 --- a/base64.h +++ b/base64.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Base64Encoder /// \brief Base64 encodes data using DUDE /// \details Base64 encodes data per RFC 4648, Base 64 Encoding. class Base64Encoder : public SimpleProxyFilter @@ -53,7 +52,6 @@ public: void IsolatedInitialize(const NameValuePairs ¶meters); }; -/// \class Base64Decoder /// \brief Base64 decodes data using DUDE /// \details Base64 encodes data per RFC 4648, Base 64 Encoding. class Base64Decoder : public BaseN_Decoder @@ -90,7 +88,6 @@ private: static const int * CRYPTOPP_API GetDecodingLookupArray(); }; -/// \class Base64URLEncoder /// \brief Base64 encodes data using a web safe alphabet /// \details Base64 encodes data per RFC 4648, Base 64 Encoding /// with URL and Filename Safe Alphabet. @@ -128,7 +125,6 @@ public: void IsolatedInitialize(const NameValuePairs ¶meters); }; -/// \class Base64URLDecoder /// \brief Base64 decodes data using a web safe alphabet /// \details Base64 encodes data per RFC 4648, Base 64 Encoding /// with URL and Filename Safe Alphabet. diff --git a/basecode.h b/basecode.h index 1eaaae6e..1bfe68d1 100644 --- a/basecode.h +++ b/basecode.h @@ -13,7 +13,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class BaseN_Encoder /// \brief Encoder for bases that are a power of 2 class CRYPTOPP_DLL BaseN_Encoder : public Unflushable { @@ -53,7 +52,6 @@ private: SecByteBlock m_outBuf; }; -/// \class BaseN_Decoder /// \brief Decoder for bases that are a power of 2 class CRYPTOPP_DLL BaseN_Decoder : public Unflushable { @@ -105,7 +103,6 @@ private: SecByteBlock m_outBuf; }; -/// \class Grouper /// \brief Filter that breaks input stream into groups of fixed size class CRYPTOPP_DLL Grouper : public Bufferless { diff --git a/blake2.h b/blake2.h index 2e575f93..fe3c9695 100644 --- a/blake2.h +++ b/blake2.h @@ -23,7 +23,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class BLAKE2_Info /// \brief BLAKE2 hash information /// \tparam T_64bit flag indicating 64-bit /// \since Crypto++ 5.6.4 @@ -43,7 +42,6 @@ struct BLAKE2_Info : public VariableKeyLength<(T_64bit ? 64 : 32),0,(T_64bit ? 6 CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return (T_64bit ? "BLAKE2b" : "BLAKE2s");} }; -/// \class BLAKE2_ParameterBlock /// \brief BLAKE2 parameter block /// \tparam T_64bit flag indicating 64-bit /// \details BLAKE2b uses BLAKE2_ParameterBlock, while BLAKE2s @@ -124,7 +122,6 @@ struct CRYPTOPP_NO_VTABLE BLAKE2_ParameterBlock byte personalization[PERSONALIZATIONSIZE]; }; -/// \class BLAKE2_State /// \brief BLAKE2 state information /// \tparam W word type /// \tparam T_64bit flag indicating 64-bit @@ -150,7 +147,6 @@ struct CRYPTOPP_NO_VTABLE BLAKE2_State size_t length; }; -/// \class BLAKE2_Base /// \brief BLAKE2 hash implementation /// \tparam W word type /// \tparam T_64bit flag indicating 64-bit diff --git a/blowfish.h b/blowfish.h index fb2a772a..5f34609f 100644 --- a/blowfish.h +++ b/blowfish.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Blowfish_Info /// \brief Blowfish block cipher information struct Blowfish_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 4, 56>, public FixedRounds<16> { @@ -20,12 +19,10 @@ struct Blowfish_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 4, // Blowfish -/// \class Blowfish /// \brief Blowfish block cipher /// \since Crypto++ 1.0 class Blowfish : public Blowfish_Info, public BlockCipherDocumentation { - /// \class Base /// \brief Class specific implementation and overrides used to operate the cipher. /// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl diff --git a/camellia.h b/camellia.h index d29f9c56..e83a2060 100644 --- a/camellia.h +++ b/camellia.h @@ -12,14 +12,12 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Camellia_Info /// \brief Camellia block cipher information struct Camellia_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 8> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "Camellia";} }; -/// \class Camellia /// \brief Camellia block cipher /// \sa Camellia class Camellia : public Camellia_Info, public BlockCipherDocumentation diff --git a/cast.h b/cast.h index 89e66362..515b3a97 100644 --- a/cast.h +++ b/cast.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class CAST /// \brief CAST block cipher base class CAST { @@ -19,19 +18,16 @@ protected: static const word32 S[8][256]; }; -/// \class CAST128_Info /// \brief CAST128 block cipher information struct CAST128_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 5, 16> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "CAST-128";} }; -/// \class CAST128 /// \brief CAST128 block cipher /// \sa CAST-128 class CAST128 : public CAST128_Info, public BlockCipherDocumentation { - /// \class Base /// \brief CAST128 block cipher default operation class CRYPTOPP_NO_VTABLE Base : public CAST, public BlockCipherImpl { @@ -43,7 +39,6 @@ class CAST128 : public CAST128_Info, public BlockCipherDocumentation FixedSizeSecBlock K; }; - /// \class Enc /// \brief CAST128 block cipher encryption operation class CRYPTOPP_NO_VTABLE Enc : public Base { @@ -51,7 +46,6 @@ class CAST128 : public CAST128_Info, public BlockCipherDocumentation void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; - /// \class Dec /// \brief CAST128 block cipher decryption operation class CRYPTOPP_NO_VTABLE Dec : public Base { @@ -64,19 +58,16 @@ public: typedef BlockCipherFinal Decryption; }; -/// \class CAST256_Info /// \brief CAST256 block cipher information struct CAST256_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 4> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "CAST-256";} }; -/// \class CAST256 /// \brief CAST256 block cipher /// \sa CAST-256 class CAST256 : public CAST256_Info, public BlockCipherDocumentation { - /// \class Base /// \brief CAST256 block cipher default operation class CRYPTOPP_NO_VTABLE Base : public CAST, public BlockCipherImpl { diff --git a/ccm.h b/ccm.h index 398da200..c381150e 100644 --- a/ccm.h +++ b/ccm.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class CCM_Base /// \brief CCM block cipher base implementation /// \details Base implementation of the AuthenticatedSymmetricCipher interface /// \since Crypto++ 5.6.0 @@ -81,7 +80,6 @@ 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 @@ -102,7 +100,6 @@ private: typename T_BlockCipher::Encryption m_cipher; }; -/// \class CCM /// \brief CCM block cipher mode of operation /// \tparam T_BlockCipher block cipher /// \tparam T_DefaultDigestSize default digest size, in bytes diff --git a/chacha.h b/chacha.h index 12547380..81c9f8ea 100644 --- a/chacha.h +++ b/chacha.h @@ -18,7 +18,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ChaCha_Info /// \brief ChaCha stream cipher information /// \since Crypto++ 5.6.4 template @@ -29,7 +28,6 @@ struct ChaCha_Info : public VariableKeyLength<32, 16, 32, 16, SimpleKeyingInterf } }; -/// \class ChaCha_Policy /// \brief ChaCha stream cipher implementation /// \since Crypto++ 5.6.4 template @@ -49,7 +47,6 @@ protected: FixedSizeAlignedSecBlock m_state; }; -/// \class ChaCha8 /// \brief ChaCha8 stream cipher /// \sa ChaCha, a variant of Salsa20 (2008.01.28). /// \since Crypto++ 5.6.4 @@ -59,7 +56,6 @@ struct ChaCha8 : public ChaCha_Info<8>, public SymmetricCipherDocumentation typedef Encryption Decryption; }; -/// \class ChaCha12 /// \brief ChaCha12 stream cipher /// \details Bernstein and ECRYPT's ChaCha is _slightly_ different from the TLS working group's implementation for /// cipher suites TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, @@ -72,7 +68,6 @@ struct ChaCha12 : public ChaCha_Info<12>, public SymmetricCipherDocumentation typedef Encryption Decryption; }; -/// \class ChaCha20 /// \brief ChaCha20 stream cipher /// \sa ChaCha, a variant of Salsa20 (2008.01.28). /// \details Bernstein and ECRYPT's ChaCha is _slightly_ different from the TLS working group's implementation for diff --git a/cmac.h b/cmac.h index 29dfb097..98afd007 100644 --- a/cmac.h +++ b/cmac.h @@ -12,7 +12,6 @@ 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 diff --git a/cryptlib.cpp b/cryptlib.cpp index fbe5687a..6750ad59 100644 --- a/cryptlib.cpp +++ b/cryptlib.cpp @@ -331,7 +331,6 @@ void RandomNumberGenerator::GenerateIntoBufferedTransformation(BufferedTransform } } -/// \class ClassNullRNG /// \brief Random Number Generator that does not produce random numbers /// \details ClassNullRNG can be used for functions that require a RandomNumberGenerator /// but don't actually use it. The class throws NotImplemented when a generation function is called. diff --git a/cryptlib.h b/cryptlib.h index 6050525e..80c1f03f 100644 --- a/cryptlib.h +++ b/cryptlib.h @@ -149,7 +149,6 @@ typedef EnumToType LittleEndian; /// \brief Provides a constant for BigEndian typedef EnumToType BigEndian; -/// \class Exception /// \brief Base class for all exceptions thrown by the library /// \details All library exceptions directly or indirectly inherit from the Exception class. /// The Exception class itself inherits from std::exception. The library does not use @@ -250,7 +249,6 @@ protected: int m_errorCode; }; -/// \class DecodingResult /// \brief Returns a decoding results struct CRYPTOPP_DLL DecodingResult { @@ -278,7 +276,6 @@ struct CRYPTOPP_DLL DecodingResult size_t messageLength; }; -/// \class NameValuePairs /// \brief Interface for retrieving values given their names /// \details This class is used to safely pass a variable number of arbitrarily typed arguments to functions /// and to read values from keys and crypto parameters. @@ -296,7 +293,6 @@ class NameValuePairs public: virtual ~NameValuePairs() {} - /// \class ValueTypeMismatch /// \brief Thrown when an unexpected type is encountered /// \details Exception thrown when trying to retrieve a value using a different type than expected class CRYPTOPP_DLL ValueTypeMismatch : public InvalidArgument @@ -454,7 +450,6 @@ public: CRYPTOPP_DLL virtual bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const =0; }; -/// \class NullNameValuePairs /// \brief Interface for retrieving values given their names /// \details This class is used when no names or values are present. Typically a program uses /// g_nullNameValuePairs rather than creating its own NullNameValuePairs object. @@ -560,7 +555,6 @@ DOCUMENTED_NAMESPACE_END // ******************************************************** -/// \class Clonable /// \brief Interface for cloning objects /// \note this is \a not implemented by most classes /// \sa ClonableImpl, NotCopyable @@ -577,7 +571,6 @@ public: virtual Clonable* Clone() const {throw NotImplemented("Clone() is not implemented yet.");} // TODO: make this =0 }; -/// \class Algorithm /// \brief Interface for all crypto algorithms class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Algorithm : public Clonable { @@ -603,7 +596,6 @@ public: virtual std::string AlgorithmName() const {return "unknown";} }; -/// \class SimpleKeyingInterface /// \brief Interface for algorithms that take byte strings as keys /// \sa FixedKeyLength(), VariableKeyLength(), SameKeyLengthAs(), SimpleKeyingInterfaceImpl() class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE SimpleKeyingInterface @@ -902,7 +894,6 @@ public: inline CipherDir GetCipherDirection() const {return IsForwardTransformation() ? ENCRYPTION : DECRYPTION;} }; -/// \class StreamTransformation /// \brief Interface for the data processing portion of stream ciphers /// \sa StreamTransformationFilter() class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE StreamTransformation : public Algorithm @@ -1064,7 +1055,6 @@ public: virtual bool IsForwardTransformation() const =0; }; -/// \class HashTransformation /// \brief Interface for hash functions and data processing part of MACs /// \details HashTransformation objects are stateful. They are created in an initial state, /// change state as Update() is called, and return to the initial @@ -1257,7 +1247,6 @@ protected: const Algorithm & GetAlgorithm() const {return *this;} }; -/// \class AuthenticatedSymmetricCipher /// \brief Interface for authenticated encryption modes of operation /// \details AuthenticatedSymmetricCipher() provides the interface for one direction /// (encryption or decryption) of a stream cipher or block cipher mode with authentication. The @@ -1332,7 +1321,6 @@ protected: {CRYPTOPP_UNUSED(headerLength); CRYPTOPP_UNUSED(messageLength); CRYPTOPP_UNUSED(footerLength);} }; -/// \class RandomNumberGenerator /// \brief Interface for random number generators /// \details The library provides a number of random number generators, from software based to hardware based generators. /// \details All generated values are uniformly distributed over the range specified. @@ -1428,9 +1416,7 @@ public: /// \sa ClassNullRNG, PK_SignatureScheme::IsProbabilistic() CRYPTOPP_DLL RandomNumberGenerator & CRYPTOPP_API NullRNG(); -/// \class WaitObjectContainer class WaitObjectContainer; -/// \class CallStack class CallStack; /// \brief Interface for objects that can be waited on. @@ -1605,7 +1591,6 @@ public: virtual size_t PutModifiable2(byte *inString, size_t length, int messageEnd, bool blocking) {return Put2(inString, length, messageEnd, blocking);} - /// \class BlockingInputOnly /// \brief Exception thrown by objects that have \a not implemented nonblocking input processing /// \details BlockingInputOnly inherits from NotImplemented struct BlockingInputOnly : public NotImplemented @@ -2168,7 +2153,6 @@ private: /// \return a reference to a BufferedTransformation object that discards all input CRYPTOPP_DLL BufferedTransformation & TheBitBucket(); -/// \class CryptoMaterial /// \brief Interface for crypto material, such as public and private keys, and crypto parameters class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CryptoMaterial : public NameValuePairs { @@ -2281,7 +2265,6 @@ public: #endif }; -/// \class GeneratableCryptoMaterial /// \brief Interface for generatable crypto material, such as private keys and crypto parameters class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE GeneratableCryptoMaterial : virtual public CryptoMaterial { @@ -2457,7 +2440,6 @@ public: virtual size_t FixedMaxPlaintextLength() const {return 0;} }; -/// \class PK_Encryptor /// \brief Interface for public-key encryptors class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE PK_Encryptor : public PK_CryptoSystem, public PublicKeyAlgorithm { @@ -2493,7 +2475,6 @@ public: BufferedTransformation *attachment=NULLPTR, const NameValuePairs ¶meters = g_nullNameValuePairs) const; }; -/// \class PK_Decryptor /// \brief Interface for public-key decryptors class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE PK_Decryptor : public PK_CryptoSystem, public PrivateKeyAlgorithm { @@ -2544,14 +2525,12 @@ public: {return Decrypt(rng, ciphertext, FixedCiphertextLength(), plaintext, parameters);} }; -/// \class PK_SignatureScheme /// \brief Interface for public-key signers and verifiers /// \details This class provides an interface common to signers and verifiers for querying scheme properties /// \sa DL_SignatureSchemeBase, TF_SignatureSchemeBase, DL_SignerBase, TF_SignerBase class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE PK_SignatureScheme { public: - /// \class InvalidKeyLength /// \brief Exception throw when the private or public key has a length that can't be used /// \details InvalidKeyLength() may be thrown by any function in this class if the private /// or public key has a length that can't be used @@ -2561,7 +2540,6 @@ public: InvalidKeyLength(const std::string &message) : Exception(OTHER_ERROR, message) {} }; - /// \class KeyTooShort /// \brief Exception throw when the private or public key is too short to sign or verify /// \details KeyTooShort() may be thrown by any function in this class if the private or public /// key is too short to sign or verify anything @@ -2623,7 +2601,6 @@ public: virtual bool RecoverablePartFirst() const =0; }; -/// \class PK_MessageAccumulator /// \brief Interface for accumulating messages to be signed or verified /// \details Only Update() should be called from the PK_MessageAccumulator() class. No other functions /// inherited from HashTransformation, like DigestSize() and TruncatedFinal(), should be called. @@ -2642,7 +2619,6 @@ public: } }; -/// \class PK_Signer /// \brief Interface for public-key signers class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE PK_Signer : public PK_SignatureScheme, public PrivateKeyAlgorithm { @@ -2702,7 +2678,6 @@ public: const byte *nonrecoverableMessage, size_t nonrecoverableMessageLength, byte *signature) const; }; -/// \class PK_Verifier /// \brief Interface for public-key signature verifiers /// \details The Recover* functions throw NotImplemented if the signature scheme does not support /// message recovery. @@ -2776,7 +2751,6 @@ public: const byte *signature, size_t signatureLength) const; }; -/// \class SimpleKeyAgreementDomain /// \brief Interface for domains of simple key agreement protocols /// \details A key agreement domain is a set of parameters that must be shared /// by two parties in a key agreement protocol, along with the algorithms diff --git a/default.h b/default.h index c6097449..2fb7982f 100644 --- a/default.h +++ b/default.h @@ -30,7 +30,6 @@ typedef SHA256 DefaultHashModule; /// \brief Default HMAC for use withDefaultEncryptorWithMAC and DefaultDecryptorWithMAC typedef HMAC DefaultMAC; -/// \class DataDecryptorErr /// \brief Exception thrown when LegacyDecryptorWithMAC or DefaultDecryptorWithMAC decryption error is encountered class DataDecryptorErr : public Exception { @@ -39,7 +38,6 @@ public: : Exception(DATA_INTEGRITY_CHECK_FAILED, s) {} }; -/// \class KeyBadErr /// \brief Exception thrown when a bad key is encountered in DefaultDecryptorWithMAC and LegacyDecryptorWithMAC class KeyBadErr : public DataDecryptorErr { @@ -47,7 +45,6 @@ class KeyBadErr : public DataDecryptorErr : DataDecryptorErr("DataDecryptor: cannot decrypt message with this passphrase") {} }; -/// \class MACBadErr /// \brief Exception thrown when an incorrect MAC is encountered in DefaultDecryptorWithMAC and LegacyDecryptorWithMAC class MACBadErr : public DataDecryptorErr { @@ -55,7 +52,6 @@ class MACBadErr : public DataDecryptorErr : DataDecryptorErr("DataDecryptorWithMAC: MAC check failed") {} }; -/// \class DataParametersInfo /// \brief Algorithm information for password-based encryptors and decryptors template struct DataParametersInfo @@ -70,7 +66,6 @@ struct DataParametersInfo typedef DataParametersInfo LegacyParametersInfo; typedef DataParametersInfo DefaultParametersInfo; -/// \class DataEncryptor /// \brief Password-based Encryptor /// \tparam BC BlockCipher based class used for encryption /// \tparam H HashTransformation based class used for mashing @@ -109,7 +104,6 @@ private: typename CBC_Mode::Encryption m_cipher; }; -/// \class DataDecryptor /// \brief Password-based Decryptor /// \tparam BC BlockCipher based class used for encryption /// \tparam H HashTransformation based class used for mashing @@ -160,7 +154,6 @@ private: }; -/// \class DataEncryptorWithMAC /// \brief Password-based encryptor with MAC /// \tparam BC BlockCipher based class used for encryption /// \tparam H HashTransformation based class used for mashing @@ -206,7 +199,6 @@ private: }; -/// \class DataDecryptorWithMAC /// \brief Password-based decryptor with MAC /// \tparam BC BlockCipher based class used for encryption /// \tparam H HashTransformation based class used for mashing @@ -259,49 +251,41 @@ private: }; #if defined(CRYPTOPP_DOXYGEN_PROCESSING) -/// \class LegacyEncryptor /// \brief Password-based encryptor (deprecated) /// \details Crypto++ 5.6.5 and earlier used the legacy algorithms, including DES_EDE2 and SHA1. /// Crypto++ 5.7 switched to AES and SHA256. The updated algorithms are available with the /// Default* classes, and the old algorithms are available with the Legacy* classes. struct LegacyEncryptor : public DataEncryptor {}; -/// \class LegacyDecryptor /// \brief Password-based decryptor (deprecated) /// \details Crypto++ 5.6.5 and earlier used the legacy algorithms, including DES_EDE2 and SHA1. /// Crypto++ 5.7 switched to AES and SHA256. The updated algorithms are available with the /// Default* classes, and the old algorithms are available with the Legacy* classes. struct LegacyDecryptor : public DataDecryptor {}; -/// \class DefaultEncryptor /// \brief Password-based encryptor /// \details Crypto++ 5.6.5 and earlier used the legacy algorithms, including DES_EDE2 and SHA1. /// Crypto++ 5.7 switched to AES and SHA256. The updated algorithms are available with the /// Default* classes, and the old algorithms are available with the Legacy* classes. struct DefaultEncryptor : public DataEncryptor {}; -/// \class DefaultDecryptor /// \brief Password-based decryptor /// \details Crypto++ 5.6.5 and earlier used the legacy algorithms, including DES_EDE2 and SHA1. /// Crypto++ 5.7 switched to AES and SHA256. The updated algorithms are available with the /// Default* classes, and the old algorithms are available with the Legacy* classes. struct DefaultDecryptor : public DataDecryptor {}; -/// \class LegacyEncryptorWithMAC /// \brief Password-based encryptor with MAC (deprecated) /// \details Crypto++ 5.6.5 and earlier used the legacy algorithms, including DES_EDE2 and SHA1. /// Crypto++ 5.7 switched to AES and SHA256. The updated algorithms are available with the /// Default* classes, and the old algorithms are available with the Legacy* classes. struct LegacyEncryptorWithMAC : public DataEncryptorWithMAC {}; -/// \class LegacyDecryptorWithMAC /// \brief Password-based decryptor with MAC (deprecated) /// \details Crypto++ 5.6.5 and earlier used the legacy algorithms, including DES_EDE2 and SHA1. /// Crypto++ 5.7 switched to AES and SHA256. The updated algorithms are available with the /// Default* classes, and the old algorithms are available with the Legacy* classes. struct LegacyDecryptorWithMAC : public DataDecryptorWithMAC {}; -/// \class DefaultEncryptorWithMAC /// \brief Password-based encryptor with MAC /// \details Crypto++ 5.6.5 and earlier used the legacy algorithms, including DES_EDE2 and SHA1. /// Crypto++ 5.7 switched to AES and SHA256. The updated algorithms are available with the /// Default* classes, and the old algorithms are available with the Legacy* classes. struct DefaultEncryptorWithMAC : public DataEncryptorWithMAC {}; -/// \class DefaultDecryptorWithMAC /// \brief Password-based decryptor with MAC /// \details Crypto++ 5.6.5 and earlier used the legacy algorithms, including DES_EDE2 and SHA1. /// Crypto++ 5.7 switched to AES and SHA256. The updated algorithms are available with the diff --git a/des.h b/des.h index e4171988..569e7d93 100644 --- a/des.h +++ b/des.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RawDES /// \brief DES block cipher base class class CRYPTOPP_DLL RawDES { @@ -25,7 +24,6 @@ protected: FixedSizeSecBlock k; }; -/// \class DES_Info /// \brief DES block cipher information struct DES_Info : public FixedBlockSize<8>, public FixedKeyLength<8> { @@ -33,7 +31,6 @@ struct DES_Info : public FixedBlockSize<8>, public FixedKeyLength<8> CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "DES";} }; -/// \class DES /// \brief DES block cipher /// \details The DES implementation in Crypto++ ignores the parity bits /// (the least significant bits of each byte) in the key. However you can use CheckKeyParityBits() @@ -42,7 +39,6 @@ struct DES_Info : public FixedBlockSize<8>, public FixedKeyLength<8> /// \since Crypto++ 1.0 class DES : public DES_Info, public BlockCipherDocumentation { - /// \class Base /// \brief DES block cipher default operation class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl, public RawDES { @@ -61,20 +57,17 @@ public: typedef BlockCipherFinal Decryption; }; -/// \class DES_EDE2_Info /// \brief 2-key TripleDES block cipher information struct DES_EDE2_Info : public FixedBlockSize<8>, public FixedKeyLength<16> { CRYPTOPP_DLL static const char * CRYPTOPP_API StaticAlgorithmName() {return "DES-EDE2";} }; -/// \class DES_EDE2 /// \brief 2-key TripleDES block cipher /// \sa DES-EDE2 /// \since Crypto++ 1.0 class DES_EDE2 : public DES_EDE2_Info, public BlockCipherDocumentation { - /// \class Base /// \brief DES_EDE2 block cipher default operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { @@ -91,20 +84,17 @@ public: typedef BlockCipherFinal Decryption; }; -/// \class DES_EDE3_Info /// \brief 3-key TripleDES block cipher information struct DES_EDE3_Info : public FixedBlockSize<8>, public FixedKeyLength<24> { CRYPTOPP_DLL static const char * CRYPTOPP_API StaticAlgorithmName() {return "DES-EDE3";} }; -/// \class DES_EDE3 /// \brief 3-key TripleDES block cipher /// \sa DES-EDE3 /// \since Crypto++ 1.0 class DES_EDE3 : public DES_EDE3_Info, public BlockCipherDocumentation { - /// \class Base /// \brief DES_EDE3 block cipher default operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { @@ -121,20 +111,17 @@ public: typedef BlockCipherFinal Decryption; }; -/// \class DES_XEX3_Info /// \brief DESX block cipher information struct DES_XEX3_Info : public FixedBlockSize<8>, public FixedKeyLength<24> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "DES-XEX3";} }; -/// \class DES_XEX3 /// \brief DESX block cipher /// \sa DES-XEX3, AKA DESX /// \since Crypto++ 1.0 class DES_XEX3 : public DES_XEX3_Info, public BlockCipherDocumentation { - /// \class Base /// \brief DES_XEX3 block cipher default operation class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { diff --git a/dh.h b/dh.h index e54cf0ea..4f462e48 100644 --- a/dh.h +++ b/dh.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class DH_Domain /// \brief Diffie-Hellman domain /// \tparam GROUP_PARAMETERS group parameters /// \tparam COFACTOR_OPTION cofactor multiplication option diff --git a/dh2.h b/dh2.h index 4795387b..48b8d464 100644 --- a/dh2.h +++ b/dh2.h @@ -10,7 +10,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class DH2 /// \brief Unified Diffie-Hellman in GF(p) /// \details A Diffie-Hellman domain is a set of parameters that must be shared /// by two parties in a key agreement protocol, along with the algorithms diff --git a/dmac.h b/dmac.h index f7e17ce0..8d65adf6 100644 --- a/dmac.h +++ b/dmac.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class DMAC_Base /// \brief DMAC message authentication code base class /// \tparam T class derived from BlockCipherDocumentation template @@ -39,7 +38,6 @@ private: unsigned int m_counter; }; -/// \class DMAC /// \brief DMAC message authentication code /// \tparam T class derived from BlockCipherDocumentation /// \sa CBC MAC for Real-Time Data Sources (08.15.1997) diff --git a/drbg.h b/drbg.h index 42b5c788..93ed781c 100644 --- a/drbg.h +++ b/drbg.h @@ -16,7 +16,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class NIST_DRBG /// \brief Interface for NIST DRBGs from SP 800-90A /// \details NIST_DRBG is the base class interface for NIST DRBGs from SP 800-90A Rev 1 (June 2015) /// \sa Recommendation @@ -146,7 +145,6 @@ protected: // ************************************************************* -/// \class Hash_DRBG /// \tparam HASH NIST approved hash derived from HashTransformation /// \tparam STRENGTH security strength, in bytes /// \tparam SEEDLENGTH seed length, in bytes @@ -261,7 +259,6 @@ private: // ************************************************************* -/// \class HMAC_DRBG /// \tparam HASH NIST approved hash derived from HashTransformation /// \tparam STRENGTH security strength, in bytes /// \tparam SEEDLENGTH seed length, in bytes diff --git a/eax.h b/eax.h index f9917fe1..e3576363 100644 --- a/eax.h +++ b/eax.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class EAX_Base /// \brief EAX block cipher base implementation /// \details Base implementation of the AuthenticatedSymmetricCipher interface /// \since Crypto++ 5.6.0 @@ -67,7 +66,6 @@ protected: CTR_Mode_ExternalCipher::Encryption m_ctr; }; -/// \class EAX_Final /// \brief EAX block cipher final implementation /// \tparam T_BlockCipher block cipher /// \tparam T_IsEncryption direction in which to operate the cipher @@ -90,7 +88,6 @@ private: #undef EAX #endif -/// \class EAX /// \brief EAX block cipher mode of operation /// \tparam T_BlockCipher block cipher /// \details \p EAX provides the \p Encryption and \p Decryption typedef. See EAX_Base diff --git a/ec2n.h b/ec2n.h index 6de58c62..25ac334e 100644 --- a/ec2n.h +++ b/ec2n.h @@ -24,7 +24,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class EC2N /// \brief Elliptic Curve over GF(2^n) class CRYPTOPP_DLL EC2N : public AbstractGroup, public EncodedPoint { @@ -97,12 +96,10 @@ private: CRYPTOPP_DLL_TEMPLATE_CLASS DL_FixedBasePrecomputationImpl; CRYPTOPP_DLL_TEMPLATE_CLASS DL_GroupPrecomputation; -/// \class EcPrecomputation /// \brief Elliptic Curve precomputation /// \tparam EC elliptic curve field template class EcPrecomputation; -/// \class EcPrecomputation /// \brief EC2N precomputation specialization /// \details Implementation of DL_GroupPrecomputation /// \sa DL_GroupPrecomputation diff --git a/eccrypto.h b/eccrypto.h index 29ce08ac..455dca17 100644 --- a/eccrypto.h +++ b/eccrypto.h @@ -168,7 +168,6 @@ protected: mutable bool m_compress, m_encodeAsOID; // presentation details }; -/// \class DL_PublicKey_EC /// \brief Elliptic Curve Discrete Log (DL) public key /// \tparam EC elliptic curve field template @@ -200,7 +199,6 @@ public: void DEREncodePublicKey(BufferedTransformation &bt) const; }; -/// \class DL_PrivateKey_EC /// \brief Elliptic Curve Discrete Log (DL) private key /// \tparam EC elliptic curve field template @@ -256,7 +254,6 @@ public: template DL_PrivateKey_EC::~DL_PrivateKey_EC() {} -/// \class ECDH /// \brief Elliptic Curve Diffie-Hellman /// \tparam EC elliptic curve field /// \tparam COFACTOR_OPTION cofactor multiplication option @@ -267,7 +264,6 @@ struct ECDH typedef DH_Domain, COFACTOR_OPTION> Domain; }; -/// \class ECMQV /// \brief Elliptic Curve Menezes-Qu-Vanstone /// \tparam EC elliptic curve field /// \tparam COFACTOR_OPTION cofactor multiplication option @@ -278,7 +274,6 @@ struct ECMQV typedef MQV_Domain, COFACTOR_OPTION> Domain; }; -/// \class ECHMQV /// \brief Hashed Elliptic Curve Menezes-Qu-Vanstone /// \tparam EC elliptic curve field /// \tparam COFACTOR_OPTION cofactor multiplication option @@ -296,7 +291,6 @@ typedef ECHMQV< ECP, DL_GroupParameters_EC< ECP >::DefaultCofactorOption, SHA256 typedef ECHMQV< ECP, DL_GroupParameters_EC< ECP >::DefaultCofactorOption, SHA384 >::Domain ECHMQV384; typedef ECHMQV< ECP, DL_GroupParameters_EC< ECP >::DefaultCofactorOption, SHA512 >::Domain ECHMQV512; -/// \class ECFHMQV /// \brief Fully Hashed Elliptic Curve Menezes-Qu-Vanstone /// \tparam EC elliptic curve field /// \tparam COFACTOR_OPTION cofactor multiplication option @@ -315,7 +309,6 @@ typedef ECFHMQV< ECP, DL_GroupParameters_EC< ECP >::DefaultCofactorOption, SHA25 typedef ECFHMQV< ECP, DL_GroupParameters_EC< ECP >::DefaultCofactorOption, SHA384 >::Domain ECFHMQV384; typedef ECFHMQV< ECP, DL_GroupParameters_EC< ECP >::DefaultCofactorOption, SHA512 >::Domain ECFHMQV512; -/// \class DL_Keys_EC /// \brief Elliptic Curve Discrete Log (DL) keys /// \tparam EC elliptic curve field template @@ -329,7 +322,6 @@ struct DL_Keys_EC template struct ECDSA; -/// \class DL_Keys_ECDSA /// \brief Elliptic Curve DSA keys /// \tparam EC elliptic curve field template @@ -339,7 +331,6 @@ struct DL_Keys_ECDSA typedef DL_PrivateKey_WithSignaturePairwiseConsistencyTest, ECDSA > PrivateKey; }; -/// \class DL_Algorithm_ECDSA /// \brief Elliptic Curve DSA (ECDSA) signature algorithm /// \tparam EC elliptic curve field template @@ -349,7 +340,6 @@ public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "ECDSA";} }; -/// \class DL_Algorithm_ECDSA_RFC6979 /// \brief Elliptic Curve DSA (ECDSA) signature algorithm based on RFC 6979 /// \tparam EC elliptic curve field /// \sa RFC 6979, Deterministic Usage of the @@ -362,7 +352,6 @@ public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "ECDSA-RFC6979";} }; -/// \class DL_Algorithm_ECNR /// \brief Elliptic Curve NR (ECNR) signature algorithm /// \tparam EC elliptic curve field template @@ -372,7 +361,6 @@ public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "ECNR";} }; -/// \class ECDSA /// \brief Elliptic Curve DSA (ECDSA) signature scheme /// \tparam EC elliptic curve field /// \tparam H HashTransformation derived class @@ -382,7 +370,6 @@ struct ECDSA : public DL_SS, DL_Algorithm_ECDSA, DL_Signat { }; -/// \class ECDSA_RFC6979 /// \brief Elliptic Curve DSA (ECDSA) deterministic signature scheme /// \tparam EC elliptic curve field /// \tparam H HashTransformation derived class @@ -399,7 +386,6 @@ struct ECDSA_RFC6979 : public DL_SS< static std::string CRYPTOPP_API StaticAlgorithmName() {return std::string("ECDSA-RFC6979/") + H::StaticAlgorithmName();} }; -/// \class ECNR /// \brief Elliptic Curve NR (ECNR) signature scheme /// \tparam EC elliptic curve field /// \tparam H HashTransformation derived class @@ -415,7 +401,6 @@ class DL_PublicKey_ECGDSA_ISO15946; template class DL_PrivateKey_ECGDSA_ISO15946; -/// \class DL_PrivateKey_ECGDSA_ISO15946 /// \brief Elliptic Curve German DSA key for ISO/IEC 15946 /// \tparam EC elliptic curve field /// \sa ECGDSA_ISO15946 @@ -498,7 +483,6 @@ public: void DEREncodePrivateKey(BufferedTransformation &bt) const; }; -/// \class DL_PublicKey_ECGDSA_ISO15946 /// \brief Elliptic Curve German DSA key for ISO/IEC 15946 /// \tparam EC elliptic curve field /// \sa ECGDSA_ISO15946 @@ -551,7 +535,6 @@ public: void DEREncodePublicKey(BufferedTransformation &bt) const; }; -/// \class DL_Keys_ECGDSA_ISO15946 /// \brief Elliptic Curve German DSA keys for ISO/IEC 15946 /// \tparam EC elliptic curve field /// \sa ECGDSA_ISO15946 @@ -563,7 +546,6 @@ struct DL_Keys_ECGDSA_ISO15946 typedef DL_PrivateKey_ECGDSA_ISO15946 PrivateKey; }; -/// \class DL_Algorithm_ECGDSA_ISO15946 /// \brief Elliptic Curve German DSA signature algorithm /// \tparam EC elliptic curve field /// \sa ECGDSA_ISO15946 @@ -575,7 +557,6 @@ public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "ECGDSA";} }; -/// \class ECGDSA /// \brief Elliptic Curve German Digital Signature Algorithm signature scheme /// \tparam EC elliptic curve field /// \tparam H HashTransformation derived class @@ -595,7 +576,6 @@ struct ECGDSA : public DL_SS< // ****************************************** -/// \class ECIES /// \brief Elliptic Curve Integrated Encryption Scheme /// \tparam COFACTOR_OPTION cofactor multiplication option /// \tparam HASH HashTransformation derived class used for key drivation and MAC computation diff --git a/ecp.h b/ecp.h index 2199b8c3..7b0a201f 100644 --- a/ecp.h +++ b/ecp.h @@ -22,7 +22,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ECP /// \brief Elliptic Curve over GF(p), where p is prime class CRYPTOPP_DLL ECP : public AbstractGroup, public EncodedPoint { @@ -104,12 +103,10 @@ private: CRYPTOPP_DLL_TEMPLATE_CLASS DL_FixedBasePrecomputationImpl; CRYPTOPP_DLL_TEMPLATE_CLASS DL_GroupPrecomputation; -/// \class EcPrecomputation /// \brief Elliptic Curve precomputation /// \tparam EC elliptic curve field template class EcPrecomputation; -/// \class EcPrecomputation /// \brief ECP precomputation specialization /// \details Implementation of DL_GroupPrecomputation with input and output /// conversions for Montgomery modular multiplication. diff --git a/ecpoint.h b/ecpoint.h index 5b726e4c..f38d9851 100644 --- a/ecpoint.h +++ b/ecpoint.h @@ -15,7 +15,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ECPPoint /// \brief Elliptical Curve Point over GF(p), where p is prime /// \since Crypto++ 2.0 struct CRYPTOPP_DLL ECPPoint @@ -49,7 +48,6 @@ struct CRYPTOPP_DLL ECPPoint CRYPTOPP_DLL_TEMPLATE_CLASS AbstractGroup; -/// \class EC2NPoint /// \brief Elliptical Curve Point over GF(2^n) /// \since Crypto++ 2.0 struct CRYPTOPP_DLL EC2NPoint @@ -83,7 +81,6 @@ struct CRYPTOPP_DLL EC2NPoint CRYPTOPP_DLL_TEMPLATE_CLASS AbstractGroup; -/// \class EncodedPoint /// \brief Abstract class for encoding and decoding ellicptic curve points /// \tparam Point ellicptic curve point /// \details EncodedPoint is an interface for encoding and decoding elliptic curve points. diff --git a/elgamal.h b/elgamal.h index 82e7d816..45b3f10b 100644 --- a/elgamal.h +++ b/elgamal.h @@ -16,7 +16,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ElGamalBase /// \brief ElGamal key agreement and encryption schemes base class /// \since Crypto++ 1.0 class CRYPTOPP_NO_VTABLE ElGamalBase : public DL_KeyAgreementAlgorithm_DH, @@ -93,7 +92,6 @@ public: virtual const DL_GroupParameters_GFP & GetGroupParameters() const =0; }; -/// \class ElGamalObjectImpl /// \brief ElGamal key agreement and encryption schemes default implementation /// \since Crypto++ 1.0 template @@ -116,7 +114,6 @@ protected: const DL_SymmetricEncryptionAlgorithm & GetSymmetricEncryptionAlgorithm() const {return *this;} }; -/// \class ElGamalKeys /// \brief ElGamal key agreement and encryption schemes keys /// \details The ElGamalKeys class used DL_PrivateKey_GFP_OldFormat and DL_PublicKey_GFP_OldFormat /// for the PrivateKey and PublicKey typedef from about Crypto++ 1.0 through Crypto++ 5.6.5. @@ -129,7 +126,6 @@ struct ElGamalKeys typedef DL_CryptoKeys_GFP::PublicKey PublicKey; }; -/// \class ElGamal /// \brief ElGamal encryption scheme with non-standard padding /// \since Crypto++ 1.0 struct ElGamal diff --git a/emsa2.h b/emsa2.h index 8dc5da20..0db5ea34 100644 --- a/emsa2.h +++ b/emsa2.h @@ -17,7 +17,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class EMSA2HashId /// \brief EMSA2 hash identifier /// \tparam H HashTransformation derived class /// \since Crypto++ 5.0 @@ -27,7 +26,6 @@ public: static const byte id; }; -/// \class EMSA2Pad /// \brief EMSA2 padding method /// \tparam BASE Message encoding method /// \since Crypto++ 5.0 @@ -68,7 +66,6 @@ template<> const byte EMSA2HashId::id; template<> const byte EMSA2HashId::id; #endif -/// \class EMSA2Pad /// \brief EMSA2 padding method /// \since Crypto++ 5.0 class CRYPTOPP_DLL EMSA2Pad : public EMSA2HashIdLookup @@ -91,7 +88,6 @@ public: // \skip EMSA2HashId can be instantiated // \until end of list -/// \class P1363_EMSA2 /// \brief EMSA2/P1363 padding method /// \details Use with RWSS and RSA_ISO /// \since Crypto++ 5.0 diff --git a/esign.h b/esign.h index 6272b389..274c1810 100644 --- a/esign.h +++ b/esign.h @@ -15,7 +15,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ESIGNFunction /// \brief ESIGN trapdoor function using the public key /// \since Crypto++ 5.0 class ESIGNFunction : public TrapdoorFunction, public ASN1CryptoMaterial @@ -58,7 +57,6 @@ protected: Integer m_n, m_e; }; -/// \class InvertibleESIGNFunction /// \brief ESIGN trapdoor function using the private key /// \since Crypto++ 5.0 class InvertibleESIGNFunction : public ESIGNFunction, public RandomizedTrapdoorFunctionInverse, public PrivateKey @@ -115,7 +113,6 @@ protected: Integer m_p, m_q; }; -/// \class EMSA5Pad /// \brief EMSA5 padding method /// \tparam T Mask Generation Function /// \since Crypto++ 5.0 @@ -142,7 +139,6 @@ public: } }; -/// \class P1363_EMSA5 /// \brief EMSA5 padding method, for use with ESIGN /// \since Crypto++ 5.0 struct P1363_EMSA5 : public SignatureStandard @@ -150,7 +146,6 @@ struct P1363_EMSA5 : public SignatureStandard typedef EMSA5Pad SignatureMessageEncodingMethod; }; -/// \class ESIGN_Keys /// \brief ESIGN keys /// \since Crypto++ 5.0 struct ESIGN_Keys @@ -160,7 +155,6 @@ struct ESIGN_Keys typedef InvertibleESIGNFunction PrivateKey; }; -/// \class ESIGN /// \brief ESIGN signature scheme, IEEE P1363a /// \tparam H HashTransformation derived class /// \tparam STANDARD Signature encoding method diff --git a/factory.h b/factory.h index ff2be1d9..d3d36e3c 100644 --- a/factory.h +++ b/factory.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ObjectFactory /// \brief Object factory interface for registering objects /// \tparam AbstractClass Base class interface of the object template @@ -23,7 +22,6 @@ public: virtual AbstractClass * CreateObject() const =0; }; -/// \class DefaultObjectFactory /// \brief Object factory for registering objects /// \tparam AbstractClass Base class interface of the object /// \tparam ConcreteClass Class object @@ -37,7 +35,6 @@ public: } }; -/// \class ObjectFactoryRegistry /// \brief Object factory registry /// \tparam AbstractClass Base class interface of the object /// \tparam instance unique identifier @@ -105,7 +102,6 @@ ObjectFactoryRegistry & ObjectFactoryRegistry @@ -123,7 +121,6 @@ public: std::istream* GetStream() {return m_store.GetStream();} }; -/// \class FileSink /// \brief Implementation of Store interface /// \details file-based implementation of Sink interface class CRYPTOPP_DLL FileSink : public Sink, public NotCopyable diff --git a/filters.h b/filters.h index 4b876c2c..c9a4c092 100644 --- a/filters.h +++ b/filters.h @@ -24,7 +24,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Filter /// \brief Implementation of BufferedTransformation's attachment interface /// \details Filter is a cornerstone of the Pipeline trinitiy. Data flows from /// Sources, through Filters, and then terminates in Sinks. The difference @@ -155,7 +154,6 @@ protected: int m_continueAt; }; -/// \class FilterPutSpaceHelper /// \brief Create a working space in a BufferedTransformation struct CRYPTOPP_DLL FilterPutSpaceHelper { @@ -213,7 +211,6 @@ struct CRYPTOPP_DLL FilterPutSpaceHelper SecByteBlock m_tempSpace; }; -/// \class MeterFilter /// \brief Measure how many bytes and messages pass through the filter /// \details measure how many bytes and messages pass through the filter. The filter also serves as valve by /// maintaining a list of ranges to skip during processing. @@ -285,7 +282,6 @@ private: size_t m_length; }; -/// \class TransparentFilter /// \brief A transparent MeterFilter /// \sa MeterFilter, OpaqueFilter class CRYPTOPP_DLL TransparentFilter : public MeterFilter @@ -296,7 +292,6 @@ public: TransparentFilter(BufferedTransformation *attachment=NULLPTR) : MeterFilter(attachment, true) {} }; -/// \class OpaqueFilter /// \brief A non-transparent MeterFilter /// \sa MeterFilter, TransparentFilter class CRYPTOPP_DLL OpaqueFilter : public MeterFilter @@ -307,7 +302,6 @@ public: OpaqueFilter(BufferedTransformation *attachment=NULLPTR) : MeterFilter(attachment, false) {} }; -/// \class FilterWithBufferedInput /// \brief Divides an input stream into discrete blocks /// \details FilterWithBufferedInput divides the input stream into a first block, a number of /// middle blocks, and a last block. First and last blocks are optional, and middle blocks may @@ -425,7 +419,6 @@ protected: BlockQueue m_queue; }; -/// \class FilterWithInputQueue /// \brief A filter that buffers input using a ByteQueue /// \details FilterWithInputQueue will buffer input using a ByteQueue. When the filter receives /// a \ref BufferedTransformation::MessageEnd() "MessageEnd()" signal it will pass the data @@ -498,7 +491,6 @@ struct BlockPaddingSchemeDef }; }; -/// \class StreamTransformationFilter /// \brief Filter wrapper for StreamTransformation /// \details StreamTransformationFilter() is a filter wrapper for StreamTransformation(). It is used when /// pipelining data for stream ciphers and confidentiality-only block ciphers. The filter will optionally @@ -553,7 +545,6 @@ protected: bool m_isSpecial; }; -/// \class HashFilter /// \brief Filter wrapper for HashTransformation /// \since Crypto++ 1.0 class CRYPTOPP_DLL HashFilter : public Bufferless, private FilterPutSpaceHelper @@ -583,7 +574,6 @@ private: std::string m_messagePutChannel, m_hashPutChannel; }; -/// \class HashVerificationFilter /// \brief Filter wrapper for HashTransformation /// \since Crypto++ 4.0 class CRYPTOPP_DLL HashVerificationFilter : public FilterWithBufferedInput @@ -591,7 +581,6 @@ class CRYPTOPP_DLL HashVerificationFilter : public FilterWithBufferedInput public: virtual ~HashVerificationFilter() {} - /// \class HashVerificationFailed /// \brief Exception thrown when a data integrity check failure is encountered class HashVerificationFailed : public Exception { @@ -647,7 +636,6 @@ private: SecByteBlock m_expectedHash; }; -/// \class AuthenticatedEncryptionFilter /// \brief Filter wrapper for encrypting with AuthenticatedSymmetricCipher /// \details AuthenticatedEncryptionFilter() is a wrapper for encrypting with AuthenticatedSymmetricCipher(), /// optionally handling padding/unpadding when needed. @@ -689,7 +677,6 @@ protected: HashFilter m_hf; }; -/// \class AuthenticatedDecryptionFilter /// \brief Filter wrapper for decrypting with AuthenticatedSymmetricCipher /// \details AuthenticatedDecryptionFilter() is a wrapper for decrypting with AuthenticatedSymmetricCipher(), /// optionally handling padding/unpadding when needed. @@ -751,7 +738,6 @@ protected: StreamTransformationFilter m_streamFilter; }; -/// \class SignerFilter /// \brief Filter wrapper for PK_Signer /// \since Crypto++ 4.0 class CRYPTOPP_DLL SignerFilter : public Unflushable @@ -780,7 +766,6 @@ private: SecByteBlock m_buf; }; -/// \class SignatureVerificationFilter /// \brief Filter wrapper for PK_Verifier /// \details This filter was formerly named VerifierFilter. The name changed at Crypto++ 5.0. /// \since Crypto++ 4.0 @@ -843,7 +828,6 @@ private: bool m_verified; }; -/// \class Redirector /// \brief Redirect input to another BufferedTransformation without owning it /// \since Crypto++ 4.0 class CRYPTOPP_DLL Redirector : public CustomSignalPropagation @@ -938,7 +922,6 @@ private: word32 m_behavior; }; -/// \class OutputProxy /// \brief Filter class that is a proxy for a sink /// \details Used By ProxyFilter /// \since Crypto++ 4.0 @@ -988,7 +971,6 @@ private: bool m_passSignal; }; -/// \class ProxyFilter /// \brief Base class for Filter classes that are proxies for a chain of other filters /// \since Crypto++ 4.0 class CRYPTOPP_DLL ProxyFilter : public FilterWithBufferedInput @@ -1015,7 +997,6 @@ protected: member_ptr m_filter; }; -/// \class SimpleProxyFilter /// \brief Proxy filter that doesn't modify the underlying filter's input or output /// \since Crypto++ 5.0 class CRYPTOPP_DLL SimpleProxyFilter : public ProxyFilter @@ -1044,7 +1025,6 @@ public: {CRYPTOPP_UNUSED(inString), CRYPTOPP_UNUSED(length); m_filter->MessageEnd();} }; -/// \class PK_EncryptorFilter /// \brief Filter wrapper for PK_Encryptor /// \details PK_DecryptorFilter is a proxy for the filter created by PK_Encryptor::CreateEncryptionFilter. /// This class provides symmetry with VerifierFilter. @@ -1060,7 +1040,6 @@ public: : SimpleProxyFilter(encryptor.CreateEncryptionFilter(rng), attachment) {} }; -/// \class PK_DecryptorFilter /// \brief Filter wrapper for PK_Decryptor /// \details PK_DecryptorFilter is a proxy for the filter created by PK_Decryptor::CreateDecryptionFilter. /// This class provides symmetry with SignerFilter. @@ -1076,7 +1055,6 @@ public: : SimpleProxyFilter(decryptor.CreateDecryptionFilter(rng), attachment) {} }; -/// \class StringSinkTemplate /// \brief Append input to a string object /// \tparam T std::basic_string type /// \details StringSinkTemplate is a StringSinkTemplate typedef @@ -1114,7 +1092,6 @@ private: T *m_output; }; -/// \class StringSink /// \brief Append input to a string object /// \details StringSink is a typedef for StringSinkTemplate. /// \sa ArraySink, ArrayXorSink @@ -1122,7 +1099,6 @@ private: DOCUMENTED_TYPEDEF(StringSinkTemplate, StringSink) CRYPTOPP_DLL_TEMPLATE_CLASS StringSinkTemplate; -/// \class RandomNumberSink /// \brief Incorporates input into RNG as additional entropy /// \since Crypto++ 4.0 class RandomNumberSink : public Bufferless @@ -1146,7 +1122,6 @@ private: RandomNumberGenerator *m_rng; }; -/// \class ArraySink /// \brief Copy input to a memory buffer /// \details ArraySink wraps a fixed size buffer. The buffer is full once Put returns non-0. /// When used in a pipleline, ArraySink silently discards input if the buffer is full. @@ -1189,7 +1164,6 @@ protected: lword m_total; }; -/// \class ArrayXorSink /// \brief Xor input to a memory buffer /// \details ArrayXorSink wraps a fixed size buffer. The buffer is full once Put returns non-0. /// When used in a pipleline, ArrayXorSink silently discards input if the buffer is full. @@ -1212,7 +1186,6 @@ public: byte * CreatePutSpace(size_t &size) {return BufferedTransformation::CreatePutSpace(size);} }; -/// \class StringStore /// \brief String-based implementation of Store interface /// \since Crypto++ 4.0 class StringStore : public Store @@ -1245,7 +1218,6 @@ private: size_t m_length, m_count; }; -/// \class RandomNumberStore /// \brief RNG-based implementation of Source interface /// \since Crypto++ 4.0 class CRYPTOPP_DLL RandomNumberStore : public Store @@ -1292,7 +1264,6 @@ private: lword m_size; }; -/// \class Source /// \brief Implementation of BufferedTransformation's attachment interface /// \details Source is a cornerstone of the Pipeline trinitiy. Data flows from /// Sources, through Filters, and then terminates in Sinks. The difference @@ -1372,7 +1343,6 @@ protected: } }; -/// \class SourceTemplate /// \brief Transform a Store into a Source /// \tparam T the class or type /// \since Crypto++ 5.0 @@ -1405,7 +1375,6 @@ protected: T m_store; }; -/// \class SourceTemplate /// \brief String-based implementation of the Source interface /// \since Crypto++ 4.0 class CRYPTOPP_DLL StringSource : public SourceTemplate @@ -1439,7 +1408,6 @@ public: : SourceTemplate(attachment) {SourceInitialize(pumpAll, MakeParameters("InputBuffer", ConstByteArrayParameter(string)));} }; -/// \class ArraySource /// \brief Pointer-based implementation of the Source interface /// \details ArraySource is a typedef for StringSource. Use the third constructor for an array source. /// The third constructor takes a pointer and length. diff --git a/fips140.h b/fips140.h index c8f4b1cd..a6f79e72 100644 --- a/fips140.h +++ b/fips140.h @@ -16,7 +16,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SelfTestFailure /// Exception thrown when a crypto algorithm is used after a self test fails /// \details The self tests for an algorithm are performed by Algortihm class /// when CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2 is defined. diff --git a/gcm.h b/gcm.h index ba4d2b44..5db85b1a 100644 --- a/gcm.h +++ b/gcm.h @@ -20,7 +20,6 @@ enum GCM_TablesOption { /// \brief Use a table with 64K entries GCM_64K_Tables}; -/// \class GCM_Base /// \brief GCM block cipher base implementation /// \details Base implementation of the AuthenticatedSymmetricCipher interface /// \since Crypto++ 5.6.0 @@ -91,7 +90,6 @@ protected: enum {REQUIRED_BLOCKSIZE = 16, HASH_BLOCKSIZE = 16}; }; -/// \class GCM_Final /// \brief GCM block cipher final implementation /// \tparam T_BlockCipher block cipher /// \tparam T_TablesOption table size, either \p GCM_2K_Tables or \p GCM_64K_Tables @@ -112,7 +110,6 @@ private: typename T_BlockCipher::Encryption m_cipher; }; -/// \class GCM /// \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 diff --git a/gfpcrypt.h b/gfpcrypt.h index 230846f7..20ecd8d8 100644 --- a/gfpcrypt.h +++ b/gfpcrypt.h @@ -30,7 +30,6 @@ NAMESPACE_BEGIN(CryptoPP) CRYPTOPP_DLL_TEMPLATE_CLASS DL_GroupParameters; -/// \class DL_GroupParameters_IntegerBased /// \brief Integer-based GroupParameters specialization class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE DL_GroupParameters_IntegerBased : public ASN1CryptoMaterial > { @@ -113,7 +112,6 @@ private: Integer m_q; }; -/// \class DL_GroupParameters_IntegerBasedImpl /// \brief Integer-based GroupParameters default implementation /// \tparam GROUP_PRECOMP group parameters precomputation specialization /// \tparam BASE_PRECOMP base class precomputation specialization @@ -154,7 +152,6 @@ public: CRYPTOPP_DLL_TEMPLATE_CLASS DL_GroupParameters_IntegerBasedImpl; -/// \class DL_GroupParameters_GFP /// \brief GF(p) group parameters class CRYPTOPP_DLL DL_GroupParameters_GFP : public DL_GroupParameters_IntegerBasedImpl { @@ -179,7 +176,6 @@ protected: int GetFieldType() const {return 1;} }; -/// \class DL_GroupParameters_GFP /// \brief GF(p) group parameters that default to safe primes class CRYPTOPP_DLL DL_GroupParameters_GFP_DefaultSafePrime : public DL_GroupParameters_GFP { @@ -192,7 +188,6 @@ protected: unsigned int GetDefaultSubgroupOrderSize(unsigned int modulusSize) const {return modulusSize-1;} }; -/// \class DL_Algorithm_GDSA /// \brief GDSA algorithm /// \tparam T FieldElement type or class template @@ -226,7 +221,6 @@ public: } }; -/// \class DL_Algorithm_DSA_RFC6979 /// \brief DSA signature algorithm based on RFC 6979 /// \tparam T FieldElement type or class /// \tparam H HashTransformation derived class @@ -384,7 +378,6 @@ private: mutable HMAC m_hmac; }; -/// \class DL_Algorithm_GDSA_ISO15946 /// \brief German Digital Signature Algorithm /// \tparam T FieldElement type or class /// \details The Digital Signature Scheme ECGDSA does not define the algorithm over integers. Rather, the @@ -431,7 +424,6 @@ CRYPTOPP_DLL_TEMPLATE_CLASS DL_Algorithm_DSA_RFC6979; CRYPTOPP_DLL_TEMPLATE_CLASS DL_Algorithm_DSA_RFC6979; CRYPTOPP_DLL_TEMPLATE_CLASS DL_Algorithm_DSA_RFC6979; -/// \class DL_Algorithm_NR /// \brief NR algorithm /// \tparam T FieldElement type or class template @@ -461,7 +453,6 @@ public: } }; -/// \class DL_PublicKey_GFP /// \brief Discrete Log (DL) public key in GF(p) groups /// \tparam GP GroupParameters derived class /// \details DSA public key format is defined in 7.3.3 of RFC 2459. The private key format is defined in 12.9 of PKCS #11 v2.10. @@ -499,7 +490,6 @@ public: {this->GetPublicElement().DEREncode(bt);} }; -/// \class DL_PrivateKey_GFP /// \brief Discrete Log (DL) private key in GF(p) groups /// \tparam GP GroupParameters derived class template @@ -564,7 +554,6 @@ public: template DL_PrivateKey_GFP::~DL_PrivateKey_GFP() {} -/// \class DL_SignatureKeys_GFP /// \brief Discrete Log (DL) signing/verification keys in GF(p) groups struct DL_SignatureKeys_GFP { @@ -573,7 +562,6 @@ struct DL_SignatureKeys_GFP typedef DL_PrivateKey_GFP PrivateKey; }; -/// \class DL_CryptoKeys_GFP /// \brief Discrete Log (DL) encryption/decryption keys in GF(p) groups struct DL_CryptoKeys_GFP { @@ -582,7 +570,6 @@ struct DL_CryptoKeys_GFP typedef DL_PrivateKey_GFP PrivateKey; }; -/// \class GDSA /// \brief DSA signature scheme /// \tparam H HashTransformation derived class /// \sa DSA-1363 @@ -596,7 +583,6 @@ struct GDSA : public DL_SS< { }; -/// \class NR /// \brief NR signature scheme /// \tparam H HashTransformation derived class /// \sa NR @@ -609,7 +595,6 @@ struct NR : public DL_SS< { }; -/// \class DL_GroupParameters_DSA /// \brief DSA group parameters /// \details These are GF(p) group parameters that are allowed by the DSA standard /// \sa DL_Keys_DSA @@ -633,7 +618,6 @@ public: template class DSA2; -/// \class DL_Keys_DSA /// \brief DSA keys /// \sa DL_GroupParameters_DSA struct DL_Keys_DSA @@ -642,7 +626,6 @@ struct DL_Keys_DSA typedef DL_PrivateKey_WithSignaturePairwiseConsistencyTest, DSA2 > PrivateKey; }; -/// \class DSA2 /// \brief DSA signature scheme /// \tparam H HashTransformation derived class /// \details The class is named DSA2 instead of DSA for backwards compatibility because DSA was a non-template class. @@ -660,7 +643,6 @@ public: static std::string CRYPTOPP_API StaticAlgorithmName() {return "DSA/" + (std::string)H::StaticAlgorithmName();} }; -/// \class DSA_RFC6979 /// \brief DSA deterministic signature scheme /// \tparam H HashTransformation derived class /// \sa DSA-1363 @@ -683,7 +665,6 @@ CRYPTOPP_DLL_TEMPLATE_CLASS DL_PublicKey_GFP; CRYPTOPP_DLL_TEMPLATE_CLASS DL_PrivateKey_GFP; CRYPTOPP_DLL_TEMPLATE_CLASS DL_PrivateKey_WithSignaturePairwiseConsistencyTest, DSA2 >; -/// \class DL_EncryptionAlgorithm_Xor /// \brief P1363 based XOR Encryption Method /// \tparam MAC MessageAuthenticationCode derived class used for MAC computation /// \tparam DHAES_MODE flag indicating DHAES mode @@ -808,7 +789,6 @@ public: } }; -/// \class DLIES /// \brief Discrete Log Integrated Encryption Scheme /// \tparam COFACTOR_OPTION cofactor multiplication option /// \tparam HASH HashTransformation derived class used for key drivation and MAC computation diff --git a/gost.h b/gost.h index 43f60a8c..f24dc5a3 100644 --- a/gost.h +++ b/gost.h @@ -11,19 +11,16 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class GOST_Info /// \brief GOST block cipher information struct GOST_Info : public FixedBlockSize<8>, public FixedKeyLength<32> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "GOST";} }; -/// \class GOST /// \brief GOST block cipher /// \sa GOST class GOST : public GOST_Info, public BlockCipherDocumentation { - /// \class Base /// \brief GOST block cipher default operation class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { @@ -40,7 +37,6 @@ class GOST : public GOST_Info, public BlockCipherDocumentation FixedSizeSecBlock m_key; }; - /// \class Enc /// \brief GOST block cipher encryption operation class CRYPTOPP_NO_VTABLE Enc : public Base { @@ -48,7 +44,6 @@ class GOST : public GOST_Info, public BlockCipherDocumentation void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; - /// \class Dec /// \brief GOST block cipher decryption operation class CRYPTOPP_NO_VTABLE Dec : public Base { diff --git a/gzip.h b/gzip.h index 93c1f6bb..b05feb4c 100644 --- a/gzip.h +++ b/gzip.h @@ -13,7 +13,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Gzip /// \brief GZIP Compression (RFC 1952) class Gzip : public Deflator { @@ -77,23 +76,18 @@ protected: std::string m_comment; }; -/// \class Gunzip /// \brief GZIP Decompression (RFC 1952) class Gunzip : public Inflator { public: typedef Inflator::Err Err; - /// \class HeaderErr /// \brief Exception thrown when a header decoding error occurs class HeaderErr : public Err {public: HeaderErr() : Err(INVALID_DATA_FORMAT, "Gunzip: header decoding error") {}}; - /// \class TailErr /// \brief Exception thrown when the tail is too short class TailErr : public Err {public: TailErr() : Err(INVALID_DATA_FORMAT, "Gunzip: tail too short") {}}; - /// \class CrcErr /// \brief Exception thrown when a CRC error occurs class CrcErr : public Err {public: CrcErr() : Err(DATA_INTEGRITY_CHECK_FAILED, "Gunzip: CRC check error") {}}; - /// \class LengthErr /// \brief Exception thrown when a length error occurs class LengthErr : public Err {public: LengthErr() : Err(DATA_INTEGRITY_CHECK_FAILED, "Gunzip: length check error") {}}; diff --git a/hex.h b/hex.h index ba6ee98f..05f10687 100644 --- a/hex.h +++ b/hex.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class HexEncoder /// \brief Converts given data to base 16 class CRYPTOPP_DLL HexEncoder : public SimpleProxyFilter { @@ -31,7 +30,6 @@ public: void IsolatedInitialize(const NameValuePairs ¶meters); }; -/// \class HexDecoder /// \brief Decode base 16 data back to bytes class CRYPTOPP_DLL HexDecoder : public BaseN_Decoder { diff --git a/hmac.h b/hmac.h index 8304df83..8367517d 100644 --- a/hmac.h +++ b/hmac.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class HMAC_Base /// \brief HMAC information /// \details HMAC_Base derives from VariableKeyLength and MessageAuthenticationCode class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE HMAC_Base : public VariableKeyLength<16, 0, INT_MAX>, public MessageAuthenticationCode @@ -40,7 +39,6 @@ private: bool m_innerHashKeyed; }; -/// \class HMAC /// \brief HMAC /// \tparam T HashTransformation derived class /// \details HMAC derives from MessageAuthenticationCodeImpl. It calculates the HMAC using diff --git a/hrtimer.h b/hrtimer.h index 9507d5bd..307b23ce 100644 --- a/hrtimer.h +++ b/hrtimer.h @@ -15,7 +15,6 @@ NAMESPACE_BEGIN(CryptoPP) typedef clock_t TimerWord; #endif -/// \class TimerBase /// \brief Base class for timers class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE TimerBase { @@ -40,7 +39,6 @@ private: TimerWord m_start, m_last; }; -/// \class ThreadUserTimer /// \brief Measure CPU time spent executing instructions of this thread (if supported by OS) /// \note ThreadUserTimer only works correctly on Windows NT or later desktops and servers. /// On Unix-based it reports process time. On Windows Phone and Windows Store it reports wall diff --git a/ida.h b/ida.h index 603e3f2c..f16cea03 100644 --- a/ida.h +++ b/ida.h @@ -16,7 +16,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RawIDA /// \brief Secret sharing and information dispersal base class /// \since Crypto++ 1.0 class RawIDA : public AutoSignaling > > @@ -63,7 +62,6 @@ protected: SecBlock m_u, m_w, m_y; }; -/// \class SecretSharing /// \brief Shamir's Secret Sharing Algorithm /// \details SecretSharing is a variant of Shamir's secret sharing algorithm /// \sa SecretRecovery, SecretRecovery, InformationDispersal, InformationRecovery @@ -89,7 +87,6 @@ protected: bool m_pad; }; -/// \class SecretRecovery /// \brief Shamir's Secret Sharing Algorithm /// \details SecretSharing is a variant of Shamir's secret sharing algorithm /// \sa SecretRecovery, SecretRecovery, InformationDispersal, InformationRecovery @@ -113,7 +110,6 @@ protected: /// a variant of Rabin's Information Dispersal Algorithm -/// \class InformationDispersal /// \brief Rabin's Information Dispersal Algorithm /// \details InformationDispersal is a variant of Rabin's information dispersal algorithm /// \sa SecretRecovery, SecretRecovery, InformationDispersal, InformationRecovery @@ -139,7 +135,6 @@ protected: unsigned int m_nextChannel; }; -/// \class InformationRecovery /// \brief Rabin's Information Dispersal Algorithm /// \details InformationDispersal is a variant of Rabin's information dispersal algorithm /// \sa SecretRecovery, SecretRecovery, InformationDispersal, InformationRecovery diff --git a/idea.h b/idea.h index 8ca362e3..b863d238 100644 --- a/idea.h +++ b/idea.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class IDEA_Info /// \brief IDEA block cipher information /// \since Crypto++ 1.0 struct IDEA_Info : public FixedBlockSize<8>, public FixedKeyLength<16>, public FixedRounds<8> @@ -19,7 +18,6 @@ struct IDEA_Info : public FixedBlockSize<8>, public FixedKeyLength<16>, public F CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "IDEA";} }; -/// \class IDEA /// \brief IDEA block cipher /// \sa IDEA /// \since Crypto++ 1.0 diff --git a/iterhash.h b/iterhash.h index 646c49be..d66998b2 100644 --- a/iterhash.h +++ b/iterhash.h @@ -18,7 +18,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class HashInputTooLong /// \brief Exception thrown when trying to hash more data than is allowed by a hash function class CRYPTOPP_DLL HashInputTooLong : public InvalidDataFormat { @@ -27,7 +26,6 @@ public: : InvalidDataFormat("IteratedHashBase: input data exceeds maximum allowed by hash function " + alg) {} }; -/// \class IteratedHashBase /// \brief Iterated hash base class /// \tparam T Hash word type /// \tparam BASE HashTransformation derived class @@ -99,7 +97,6 @@ private: T m_countLo, m_countHi; }; -/// \class IteratedHash /// \brief Iterated hash base class /// \tparam T_HashWordType Hash word type /// \tparam T_Endianness Endianness type of hash @@ -146,7 +143,6 @@ protected: FixedSizeSecBlock m_data; }; -/// \class IteratedHashWithStaticTransform /// \brief Iterated hash with a static transformation function /// \tparam T_HashWordType Hash word type /// \tparam T_Endianness Endianness type of hash diff --git a/kalyna.h b/kalyna.h index b9fa998c..54ab3e84 100644 --- a/kalyna.h +++ b/kalyna.h @@ -20,7 +20,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Kalyna128_Info /// \brief Kalyna-128 block cipher information /// \since Crypto++ 6.0 struct CRYPTOPP_NO_VTABLE Kalyna128_Info : public FixedBlockSize<16>, VariableKeyLength<16, 16, 32> @@ -32,7 +31,6 @@ struct CRYPTOPP_NO_VTABLE Kalyna128_Info : public FixedBlockSize<16>, VariableKe } }; -/// \class Kalyna256_Info /// \brief Kalyna-256 block cipher information /// \since Crypto++ 6.0 struct CRYPTOPP_NO_VTABLE Kalyna256_Info : public FixedBlockSize<32>, VariableKeyLength<32, 32, 64> @@ -44,7 +42,6 @@ struct CRYPTOPP_NO_VTABLE Kalyna256_Info : public FixedBlockSize<32>, VariableKe } }; -/// \class Kalyna512_Info /// \brief Kalyna-512 block cipher information /// \since Crypto++ 6.0 struct CRYPTOPP_NO_VTABLE Kalyna512_Info : public FixedBlockSize<64>, FixedKeyLength<64> @@ -56,7 +53,6 @@ struct CRYPTOPP_NO_VTABLE Kalyna512_Info : public FixedBlockSize<64>, FixedKeyLe } }; -/// \class Kalyna /// \brief Kalyna block cipher /// \since Crypto++ 6.0 class CRYPTOPP_NO_VTABLE Kalyna_Base diff --git a/keccak.h b/keccak.h index 89599b4e..a686f0a3 100644 --- a/keccak.h +++ b/keccak.h @@ -17,7 +17,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Keccak /// \brief Keccak message digest base class /// \details The Crypto++ Keccak implementation uses F1600 with XOF d=0x01. /// FIPS 202 conformance (XOF d=0x06) is available in SHA3 classes. @@ -66,7 +65,6 @@ protected: unsigned int m_digestSize, m_counter; }; -/// \class Keccak_Final /// \brief Keccak message digest template /// \tparam T_DigestSize the size of the digest, in bytes /// \since Crypto++ 6.0 diff --git a/lubyrack.h b/lubyrack.h index 4aadab2c..9b878727 100644 --- a/lubyrack.h +++ b/lubyrack.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class LR_Info /// \brief Luby-Rackoff block cipher information template struct LR_Info : public VariableKeyLength<16, 0, 2*(INT_MAX/2), 2>, public FixedBlockSize<2*T::DIGESTSIZE> @@ -19,7 +18,6 @@ struct LR_Info : public VariableKeyLength<16, 0, 2*(INT_MAX/2), 2>, public Fixed static std::string StaticAlgorithmName() {return std::string("LR/")+T::StaticAlgorithmName();} }; -/// \class LR /// \brief Luby-Rackoff block cipher template class LR : public LR_Info, public BlockCipherDocumentation diff --git a/luc.h b/luc.h index fa4130c3..3d021461 100644 --- a/luc.h +++ b/luc.h @@ -209,7 +209,6 @@ private: Integer m_g; }; -/// \class DL_GroupParameters_LUC /// \brief LUC GroupParameters specialization class DL_GroupParameters_LUC : public DL_GroupParameters_IntegerBasedImpl { @@ -240,7 +239,6 @@ private: int GetFieldType() const {return 2;} }; -/// \class DL_GroupParameters_LUC_DefaultSafePrime /// \brief GF(p) group parameters that default to safe primes class DL_GroupParameters_LUC_DefaultSafePrime : public DL_GroupParameters_LUC { @@ -251,7 +249,6 @@ protected: unsigned int GetDefaultSubgroupOrderSize(unsigned int modulusSize) const {return modulusSize-1;} }; -/// \class DL_Algorithm_LUC_HMP /// \brief LUC HMP signature algorithm class DL_Algorithm_LUC_HMP : public DL_ElgamalLikeSignatureAlgorithm { @@ -293,7 +290,6 @@ struct DL_CryptoKeys_LUC typedef DL_PrivateKey_GFP PrivateKey; }; -/// \class LUC_IES /// \brief LUC Integrated Encryption Scheme /// \tparam COFACTOR_OPTION cofactor multiplication option /// \tparam HASH HashTransformation derived class used for key drivation and MAC computation diff --git a/mars.h b/mars.h index 120cb278..b27fe1a6 100644 --- a/mars.h +++ b/mars.h @@ -11,14 +11,12 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class MARS_Info /// \brief MARS block cipher information struct MARS_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 56, 8> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "MARS";} }; -/// \class MARS /// \brief MARS block cipher /// \sa MARS class MARS : public MARS_Info, public BlockCipherDocumentation diff --git a/md5.h b/md5.h index 2ae8af0d..b64c8304 100644 --- a/md5.h +++ b/md5.h @@ -7,7 +7,6 @@ NAMESPACE_BEGIN(CryptoPP) namespace Weak1 { -/// \class MD5 /// \brief MD5 message digest /// \sa MD5 /// \since Crypto++ 1.0 diff --git a/mdc.h b/mdc.h index 18ddd2b7..a49a1ad0 100644 --- a/mdc.h +++ b/mdc.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class MDC_Info /// \tparam B BlockCipher derived class /// \brief MDC_Info cipher information template @@ -28,7 +27,6 @@ struct MDC_Info : public FixedBlockSize, public FixedKeyLength class MDC : public MDC_Info { - /// \class Enc /// \brief MDC cipher encryption operation class CRYPTOPP_NO_VTABLE Enc : public BlockCipherImpl > { diff --git a/mersenne.h b/mersenne.h index f8ed9fa1..4cebdd9d 100644 --- a/mersenne.h +++ b/mersenne.h @@ -14,7 +14,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class MersenneTwister /// \brief Mersenne Twister class for Monte-Carlo simulations /// \tparam K Magic constant /// \tparam M Period parameter @@ -200,7 +199,6 @@ private: word32 m_idx; }; -/// \class MT19937 /// \brief Original MT19937 generator provided in the ACM paper. /// \details MT19937 uses 4537 as default initial seed. /// \sa MT19937ar, Mersenne twister: @@ -212,7 +210,6 @@ class MT19937 : public MersenneTwister<0x9908B0DF /*2567483615*/, 397, 624, 0x10 typedef MersenneTwister<0x9908B0DF /*2567483615*/, 397, 624, 0x10DCD /*69069*/, 4537> MT19937; #endif -/// \class MT19937ar /// \brief Updated MT19937 generator adapted to provide an array for initialization. /// \details MT19937 uses 5489 as default initial seed. Use this generator when interoperating with C++11's /// mt19937 class. diff --git a/misc.h b/misc.h index 4e34cdcf..cf265ddd 100644 --- a/misc.h +++ b/misc.h @@ -210,7 +210,6 @@ class CRYPTOPP_NO_VTABLE ThreeBases : public BASE1, public BASE2, public BASE3 }; #endif // CRYPTOPP_DOXYGEN_PROCESSING -/// \class ObjectHolder /// \tparam T class or type /// \brief Uses encapsulation to hide an object in derived classes /// \details The object T is declared as protected. @@ -221,7 +220,6 @@ protected: T m_object; }; -/// \class NotCopyable /// \brief Ensures an object is not copyable /// \details NotCopyable ensures an object is not copyable by making the /// copy constructor and assignment operator private. Deleters are not @@ -236,7 +234,6 @@ private: void operator=(const NotCopyable &); }; -/// \class NewObject /// \brief An object factory function /// \tparam T class or type /// \details NewObject overloads operator()(). @@ -2303,7 +2300,6 @@ inline void PutWord(bool assumeAligned, ByteOrder order, byte *block, T value, c #endif } -/// \class GetBlock /// \brief Access a block of memory /// \tparam T class or type /// \tparam B enumeration indicating endianness @@ -2345,7 +2341,6 @@ private: const byte *m_block; }; -/// \class PutBlock /// \brief Access a block of memory /// \tparam T class or type /// \tparam B enumeration indicating endianness @@ -2390,7 +2385,6 @@ private: byte *m_block; }; -/// \class BlockGetAndPut /// \brief Access a block of memory /// \tparam T class or type /// \tparam B enumeration indicating endianness @@ -2436,7 +2430,6 @@ T StringToWord(const std::string &str, ByteOrder order = BIG_ENDIAN_ORDER) // ************** help remove warning on g++ *************** -/// \class SafeShifter /// \brief Safely shift values when undefined behavior could occur /// \tparam overflow boolean flag indicating if overflow is present /// \details SafeShifter safely shifts values when undefined behavior could occur under C/C++ rules. @@ -2445,7 +2438,6 @@ T StringToWord(const std::string &str, ByteOrder order = BIG_ENDIAN_ORDER) /// \sa SafeShifter, SafeShifter template struct SafeShifter; -/// \class SafeShifter /// \brief Shifts a value in the presence of overflow /// \details the true template parameter indicates overflow would occur. /// In this case, SafeShifter clamps the value and returns 0. @@ -2476,7 +2468,6 @@ template<> struct SafeShifter } }; -/// \class SafeShifter /// \brief Shifts a value in the absence of overflow /// \details the false template parameter indicates overflow would not occur. /// In this case, SafeShifter returns the shfted value. diff --git a/modarith.h b/modarith.h index 709a9121..740e581c 100644 --- a/modarith.h +++ b/modarith.h @@ -25,7 +25,6 @@ CRYPTOPP_DLL_TEMPLATE_CLASS AbstractGroup; CRYPTOPP_DLL_TEMPLATE_CLASS AbstractRing; CRYPTOPP_DLL_TEMPLATE_CLASS AbstractEuclideanDomain; -/// \class ModularArithmetic /// \brief Ring of congruence classes modulo n /// \details This implementation represents each congruence class as the smallest /// non-negative integer in that class. @@ -263,7 +262,6 @@ protected: // const ModularArithmetic::RandomizationParameter ModularArithmetic::DefaultRandomizationParameter = 0 ; -/// \class MontgomeryRepresentation /// \brief Performs modular arithmetic in Montgomery representation for increased speed /// \details The Montgomery representation represents each congruence class [a] as /// a*r\%n, where r is a convenient power of 2. diff --git a/modes.h b/modes.h index b153cb5d..cbffe46d 100644 --- a/modes.h +++ b/modes.h @@ -30,7 +30,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class CipherModeDocumentation /// \brief Block cipher mode of operation information /// \details Each class derived from this one defines two types, Encryption and Decryption, /// both of which implement the SymmetricCipher interface. @@ -46,7 +45,6 @@ struct CipherModeDocumentation : public SymmetricCipherDocumentation { }; -/// \class CipherModeBase /// \brief Block cipher mode of operation information class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CipherModeBase : public SymmetricCipher { @@ -95,7 +93,6 @@ protected: AlignedSecByteBlock m_register; }; -/// \class ModePolicyCommonTemplate /// \brief Block cipher mode of operation common operations /// \tparam POLICY_INTERFACE common operations template @@ -114,7 +111,6 @@ void ModePolicyCommonTemplate::CipherSetKey(const NameValuePai SetFeedbackSize(feedbackSize); } -/// \class CFB_ModePolicy /// \brief CFB block cipher mode of operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CFB_ModePolicy : public ModePolicyCommonTemplate { @@ -149,7 +145,6 @@ inline void CopyOrZero(void *dest, size_t d, const void *src, size_t s) memset(dest, 0, d); } -/// \class OFB_ModePolicy /// \brief OFB block cipher mode of operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE OFB_ModePolicy : public ModePolicyCommonTemplate { @@ -166,7 +161,6 @@ private: void CipherResynchronize(byte *keystreamBuffer, const byte *iv, size_t length); }; -/// \class CTR_ModePolicy /// \brief CTR block cipher mode of operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CTR_ModePolicy : public ModePolicyCommonTemplate { @@ -192,7 +186,6 @@ protected: AlignedSecByteBlock m_counterArray; }; -/// \class BlockOrientedCipherModeBase /// \brief Block cipher mode of operation default implementation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE BlockOrientedCipherModeBase : public CipherModeBase { @@ -212,7 +205,6 @@ protected: SecByteBlock m_buffer; }; -/// \class ECB_OneWay /// \brief ECB block cipher mode of operation default implementation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE ECB_OneWay : public BlockOrientedCipherModeBase { @@ -226,7 +218,6 @@ public: void ProcessData(byte *outString, const byte *inString, size_t length); }; -/// \class CBC_ModeBase /// \brief CBC block cipher mode of operation default implementation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_ModeBase : public BlockOrientedCipherModeBase { @@ -238,7 +229,6 @@ public: unsigned int MinLastBlockSize() const {return 0;} }; -/// \class CBC_Encryption /// \brief CBC block cipher mode of operation encryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_Encryption : public CBC_ModeBase { @@ -246,7 +236,6 @@ public: void ProcessData(byte *outString, const byte *inString, size_t length); }; -/// \class CBC_CTS_Encryption /// \brief CBC-CTS block cipher mode of operation encryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_CTS_Encryption : public CBC_Encryption { @@ -267,7 +256,6 @@ protected: byte *m_stolenIV; }; -/// \class CBC_Decryption /// \brief CBC block cipher mode of operation decryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_Decryption : public CBC_ModeBase { @@ -281,7 +269,6 @@ protected: AlignedSecByteBlock m_temp; }; -/// \class CBC_CTS_Decryption /// \brief CBC-CTS block cipher mode of operation decryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CBC_CTS_Decryption : public CBC_Decryption { @@ -290,7 +277,6 @@ public: size_t ProcessLastBlock(byte *outString, size_t outLength, const byte *inString, size_t inLength); }; -/// \class CipherModeFinalTemplate_CipherHolder /// \brief Block cipher mode of operation aggregate template class CipherModeFinalTemplate_CipherHolder : protected ObjectHolder, public AlgorithmImpl > @@ -321,7 +307,6 @@ public: } }; -/// \class CipherModeFinalTemplate_ExternalCipher /// \tparam BASE CipherModeFinalTemplate_CipherHolder base class /// \details Base class for external mode cipher combinations template @@ -342,7 +327,6 @@ CRYPTOPP_DLL_TEMPLATE_CLASS CFB_CipherTemplate >; CRYPTOPP_DLL_TEMPLATE_CLASS CFB_DecryptionTemplate >; -/// \class CFB_Mode /// \brief CFB block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -353,7 +337,6 @@ struct CFB_Mode : public CipherModeDocumentation typedef CipherModeFinalTemplate_CipherHolder > > > Decryption; }; -/// \class CFB_Mode_ExternalCipher /// \brief CFB mode, external cipher. /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -363,7 +346,6 @@ struct CFB_Mode_ExternalCipher : public CipherModeDocumentation typedef CipherModeFinalTemplate_ExternalCipher > > > Decryption; }; -/// \class CFB_FIPS_Mode /// \brief CFB block cipher mode of operation providing FIPS validated cryptography. /// \details Requires full block plaintext according to FIPS 800-38A /// \sa Modes of Operation @@ -375,7 +357,6 @@ struct CFB_FIPS_Mode : public CipherModeDocumentation typedef CipherModeFinalTemplate_CipherHolder > > > > Decryption; }; -/// \class CFB_FIPS_Mode_ExternalCipher /// \brief CFB mode, external cipher, providing FIPS validated cryptography. /// \details Requires full block plaintext according to FIPS 800-38A /// \sa Modes of Operation @@ -388,7 +369,6 @@ struct CFB_FIPS_Mode_ExternalCipher : public CipherModeDocumentation CRYPTOPP_DLL_TEMPLATE_CLASS AdditiveCipherTemplate >; -/// \class OFB_Mode /// \brief OFB block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -399,7 +379,6 @@ struct OFB_Mode : public CipherModeDocumentation typedef Encryption Decryption; }; -/// \class OFB_Mode_ExternalCipher /// \brief OFB mode, external cipher. /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -412,7 +391,6 @@ struct OFB_Mode_ExternalCipher : public CipherModeDocumentation CRYPTOPP_DLL_TEMPLATE_CLASS AdditiveCipherTemplate >; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher > > >; -/// \class CTR_Mode /// \brief CTR block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -423,7 +401,6 @@ struct CTR_Mode : public CipherModeDocumentation typedef Encryption Decryption; }; -/// \class CTR_Mode_ExternalCipher /// \brief CTR mode, external cipher. /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -433,7 +410,6 @@ struct CTR_Mode_ExternalCipher : public CipherModeDocumentation typedef Encryption Decryption; }; -/// \class ECB_Mode /// \brief ECB block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -446,7 +422,6 @@ struct ECB_Mode : public CipherModeDocumentation CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; -/// \class ECB_Mode_ExternalCipher /// \brief ECB mode, external cipher. /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -456,7 +431,6 @@ struct ECB_Mode_ExternalCipher : public CipherModeDocumentation typedef Encryption Decryption; }; -/// \class CBC_Mode /// \brief CBC block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -470,7 +444,6 @@ struct CBC_Mode : public CipherModeDocumentation CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; -/// \class CBC_Mode_ExternalCipher /// \brief CBC mode, external cipher /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -480,7 +453,6 @@ struct CBC_Mode_ExternalCipher : public CipherModeDocumentation typedef CipherModeFinalTemplate_ExternalCipher Decryption; }; -/// \class CBC_CTS_Mode /// \brief CBC-CTS block cipher mode of operation /// \sa Modes of Operation /// on the Crypto++ wiki. @@ -494,7 +466,6 @@ struct CBC_CTS_Mode : public CipherModeDocumentation CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; CRYPTOPP_DLL_TEMPLATE_CLASS CipherModeFinalTemplate_ExternalCipher; -/// \class CBC_CTS_Mode_ExternalCipher /// \brief CBC mode with ciphertext stealing, external cipher /// \sa Modes of Operation /// on the Crypto++ wiki. diff --git a/mqv.h b/mqv.h index 23464c3c..6ab8d207 100644 --- a/mqv.h +++ b/mqv.h @@ -15,7 +15,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class MQV_Domain /// \brief MQV domain for performing authenticated key agreement /// \tparam GROUP_PARAMETERS doamin parameters /// \tparam COFACTOR_OPTION cofactor option diff --git a/nbtheory.h b/nbtheory.h index 6048eaac..6ee17abf 100644 --- a/nbtheory.h +++ b/nbtheory.h @@ -75,7 +75,6 @@ CRYPTOPP_DLL bool CRYPTOPP_API IsPrime(const Integer &p); /// level is greater than 1, then 10 round RabinMillerTest() primality testing is performed. CRYPTOPP_DLL bool CRYPTOPP_API VerifyPrime(RandomNumberGenerator &rng, const Integer &p, unsigned int level = 1); -/// \class PrimeSelector /// \brief Application callback to signal suitability of a cabdidate prime class CRYPTOPP_DLL PrimeSelector { @@ -143,7 +142,6 @@ CRYPTOPP_DLL unsigned int CRYPTOPP_API FactoringWorkFactor(unsigned int bitlengt // ******************************************************** -/// \class PrimeAndGenerator /// \brief Generator of prime numbers of special forms class CRYPTOPP_DLL PrimeAndGenerator { diff --git a/osrng.h b/osrng.h index d5cf3394..0dbca3ff 100644 --- a/osrng.h +++ b/osrng.h @@ -20,7 +20,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class OS_RNG_Err /// \brief Exception thrown when an operating system error is encountered class CRYPTOPP_DLL OS_RNG_Err : public Exception { @@ -33,7 +32,6 @@ public: #ifdef NONBLOCKING_RNG_AVAILABLE #ifdef CRYPTOPP_WIN32_AVAILABLE -/// \class MicrosoftCryptoProvider /// \brief Wrapper for Microsoft crypto service provider /// \sa \def USE_MS_CRYPTOAPI, \def USE_MS_CNGAPI class CRYPTOPP_DLL MicrosoftCryptoProvider @@ -80,7 +78,6 @@ private: #endif // CRYPTOPP_WIN32_AVAILABLE -/// \class NonblockingRng /// \brief Wrapper class for /dev/random and /dev/srandom /// \details Encapsulates CryptoAPI's CryptGenRandom() or CryptoNG's BCryptGenRandom() /// on Windows, or /dev/urandom on Unix and compatibles. @@ -112,7 +109,6 @@ protected: #if defined(BLOCKING_RNG_AVAILABLE) || defined(CRYPTOPP_DOXYGEN_PROCESSING) -/// \class BlockingRng /// \brief Wrapper class for /dev/random and /dev/srandom /// \details Encapsulates /dev/random on Linux, OS X and Unix; and /dev/srandom on the BSDs. /// \note On Linux the /dev/random interface is effectively deprecated. According to the @@ -153,7 +149,6 @@ protected: /// by way of BlockingRng, if available. CRYPTOPP_DLL void CRYPTOPP_API OS_GenerateRandomBlock(bool blocking, byte *output, size_t size); -/// \class AutoSeededRandomPool /// \brief Automatically Seeded Randomness Pool /// \details This class seeds itself using an operating system provided RNG. /// AutoSeededRandomPool was suggested by Leonard Janke. @@ -178,7 +173,6 @@ public: void Reseed(bool blocking = false, unsigned int seedSize = 32); }; -/// \class AutoSeededX917RNG /// \tparam BLOCK_CIPHER a block cipher /// \brief Automatically Seeded X9.17 RNG /// \details AutoSeededX917RNG is from ANSI X9.17 Appendix C, seeded using an OS provided RNG. @@ -262,7 +256,6 @@ void AutoSeededX917RNG::Reseed(bool blocking, const byte *input, s CRYPTOPP_DLL_TEMPLATE_CLASS AutoSeededX917RNG; #if defined(CRYPTOPP_DOXYGEN_PROCESSING) -/// \class DefaultAutoSeededRNG /// \brief A typedef providing a default generator /// \details DefaultAutoSeededRNG is a typedef of either AutoSeededX917RNG or AutoSeededRandomPool. /// If CRYPTOPP_ENABLE_COMPLIANCE_WITH_FIPS_140_2 is defined, then DefaultAutoSeededRNG is diff --git a/panama.h b/panama.h index 2482062d..71953a4a 100644 --- a/panama.h +++ b/panama.h @@ -33,7 +33,6 @@ protected: }; namespace Weak { -/// \class PanamaHash /// \brief Panama hash /// \sa Panama Hash template @@ -54,7 +53,6 @@ protected: }; } -/// \class HermeticHashFunctionMAC /// \brief MAC construction using a hermetic hash function template class HermeticHashFunctionMAC : public AlgorithmImpl > >, T_Info> @@ -111,7 +109,6 @@ protected: }; namespace Weak { -/// \class PanamaMAC /// \brief Panama message authentication code template class PanamaMAC : public HermeticHashFunctionMAC > @@ -123,7 +120,6 @@ public: }; } -/// \class PanamaCipherInfo /// \brief Panama stream cipher information template struct PanamaCipherInfo : public FixedKeyLength<32, SimpleKeyingInterface::UNIQUE_IV, 32> @@ -131,7 +127,6 @@ struct PanamaCipherInfo : public FixedKeyLength<32, SimpleKeyingInterface::UNIQU CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return B::ToEnum() == BIG_ENDIAN_ORDER ? "Panama-BE" : "Panama-LE";} }; -/// \class PanamaCipherPolicy /// \brief Panama stream cipher operation template class PanamaCipherPolicy : public AdditiveCipherConcretePolicy, @@ -148,7 +143,6 @@ protected: FixedSizeSecBlock m_key; }; -/// \class PanamaCipher /// \brief Panama stream cipher /// \sa Panama Stream Cipher template diff --git a/pkcspad.h b/pkcspad.h index 3bdb18ff..88d9d735 100644 --- a/pkcspad.h +++ b/pkcspad.h @@ -18,7 +18,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class PKCS_EncryptionPaddingScheme /// \brief PKCS #1 v1.5 Encryption Padding Scheme /// \sa EME-PKCS1-v1_5 class PKCS_EncryptionPaddingScheme : public PK_EncryptionMessageEncodingMethod @@ -31,7 +30,6 @@ public: DecodingResult Unpad(const byte *padded, size_t paddedLength, byte *raw, const NameValuePairs ¶meters) const; }; -/// \class PKCS_DigestDecoration /// \brief PKCS #1 decoration data structure template class PKCS_DigestDecoration { @@ -84,7 +82,6 @@ template<> const byte PKCS_DigestDecoration::decoration[]; template<> const unsigned int PKCS_DigestDecoration::length; #endif -/// \class PKCS1v15_SignatureMessageEncodingMethod /// \brief PKCS #1 v1.5 Signature Encoding Scheme /// \sa EMSA-PKCS1-v1_5 class CRYPTOPP_DLL PKCS1v15_SignatureMessageEncodingMethod : public PK_DeterministicSignatureMessageEncodingMethod diff --git a/poly1305.h b/poly1305.h index 006a91bf..a8d2219a 100644 --- a/poly1305.h +++ b/poly1305.h @@ -52,7 +52,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Poly1305_Base /// \brief Poly1305 message authentication code base class /// \tparam T class derived from BlockCipherDocumentation with 16-byte key and 16-byte blocksize /// \since Crypto++ 6.0 @@ -100,7 +99,6 @@ protected: bool m_used; }; -/// \class Poly1305 /// \brief Poly1305 message authentication code /// \tparam T class derived from BlockCipherDocumentation with 16-byte key and 16-byte blocksize /// \details Poly1305-AES is a state-of-the-art message-authentication code suitable for a wide diff --git a/pubkey.h b/pubkey.h index 4a84b012..f0b02e0b 100644 --- a/pubkey.h +++ b/pubkey.h @@ -60,7 +60,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class TrapdoorFunctionBounds /// \brief Provides range for plaintext and ciphertext lengths /// \details A trapdoor function is a function that is easy to compute in one direction, /// but difficult to compute in the opposite direction without special knowledge. @@ -93,7 +92,6 @@ public: virtual Integer MaxImage() const {return --ImageBound();} }; -/// \class RandomizedTrapdoorFunction /// \brief Applies the trapdoor function, using random data if required /// \details ApplyFunction() is the foundation for encrypting a message under a public key. /// Derived classes will override it at some point. @@ -119,7 +117,6 @@ public: virtual bool IsRandomized() const {return true;} }; -/// \class TrapdoorFunction /// \brief Applies the trapdoor function /// \details ApplyFunction() is the foundation for encrypting a message under a public key. /// Derived classes will override it at some point. @@ -149,7 +146,6 @@ public: virtual Integer ApplyFunction(const Integer &x) const =0; }; -/// \class RandomizedTrapdoorFunctionInverse /// \brief Applies the inverse of the trapdoor function, using random data if required /// \details CalculateInverse() is the foundation for decrypting a message under a private key /// in a public key cryptosystem. Derived classes will override it at some point. @@ -174,7 +170,6 @@ public: virtual bool IsRandomized() const {return true;} }; -/// \class TrapdoorFunctionInverse /// \brief Applies the inverse of the trapdoor function /// \details CalculateInverse() is the foundation for decrypting a message under a private key /// in a public key cryptosystem. Derived classes will override it at some point. @@ -209,7 +204,6 @@ public: // ******************************************************** -/// \class PK_EncryptionMessageEncodingMethod /// \brief Message encoding method for public key encryption class CRYPTOPP_NO_VTABLE PK_EncryptionMessageEncodingMethod { @@ -229,7 +223,6 @@ public: // ******************************************************** -/// \class TF_Base /// \brief The base for trapdoor based cryptosystems /// \tparam TFI trapdoor function interface derived class /// \tparam MEI message encoding interface derived class @@ -250,7 +243,6 @@ protected: // ******************************************************** -/// \class PK_FixedLengthCryptoSystemImpl /// \brief Public key trapdoor function default implementation /// \tparam BASE public key cryptosystem with a fixed length template @@ -268,7 +260,6 @@ public: virtual size_t FixedCiphertextLength() const =0; }; -/// \class TF_CryptoSystemBase /// \brief Trapdoor function cryptosystem base class /// \tparam INTFACE public key cryptosystem base interface /// \tparam BASE public key cryptosystem implementation base @@ -288,7 +279,6 @@ protected: size_t PaddedBlockBitLength() const {return SaturatingSubtract(this->GetTrapdoorFunctionBounds().PreimageBound().BitCount(),1U);} }; -/// \class TF_DecryptorBase /// \brief Trapdoor function cryptosystems decryption base class class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE TF_DecryptorBase : public TF_CryptoSystemBase > { @@ -298,7 +288,6 @@ public: DecodingResult Decrypt(RandomNumberGenerator &rng, const byte *ciphertext, size_t ciphertextLength, byte *plaintext, const NameValuePairs ¶meters = g_nullNameValuePairs) const; }; -/// \class TF_EncryptorBase /// \brief Trapdoor function cryptosystems encryption base class class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE TF_EncryptorBase : public TF_CryptoSystemBase > { @@ -313,7 +302,6 @@ public: // Typedef change due to Clang, http://github.com/weidai11/cryptopp/issues/300 typedef std::pair HashIdentifier; -/// \class PK_SignatureMessageEncodingMethod /// \brief Interface for message encoding method for public key signature schemes. /// \details PK_SignatureMessageEncodingMethod provides interfaces for message /// encoding method for public key signature schemes. The methods support both @@ -397,7 +385,6 @@ public: }; }; -/// \class PK_DeterministicSignatureMessageEncodingMethod /// \brief Interface for message encoding method for public key signature schemes. /// \details PK_DeterministicSignatureMessageEncodingMethod provides interfaces /// for message encoding method for public key signature schemes. @@ -409,7 +396,6 @@ public: byte *representative, size_t representativeBitLength) const; }; -/// \class PK_RecoverableSignatureMessageEncodingMethod /// \brief Interface for message encoding method for public key signature schemes. /// \details PK_RecoverableSignatureMessageEncodingMethod provides interfaces /// for message encoding method for public key signature schemes. @@ -421,7 +407,6 @@ public: byte *representative, size_t representativeBitLength) const; }; -/// \class DL_SignatureMessageEncodingMethod_DSA /// \brief Interface for message encoding method for public key signature schemes. /// \details DL_SignatureMessageEncodingMethod_DSA provides interfaces /// for message encoding method for DSA. @@ -434,7 +419,6 @@ public: byte *representative, size_t representativeBitLength) const; }; -/// \class DL_SignatureMessageEncodingMethod_NR /// \brief Interface for message encoding method for public key signature schemes. /// \details DL_SignatureMessageEncodingMethod_NR provides interfaces /// for message encoding method for Nyberg-Rueppel. @@ -448,7 +432,6 @@ public: }; #if 0 -/// \class DL_SignatureMessageEncodingMethod_SM2 /// \brief Interface for message encoding method for public key signature schemes. /// \details DL_SignatureMessageEncodingMethod_SM2 provides interfaces /// for message encoding method for SM2. @@ -462,7 +445,6 @@ public: }; #endif -/// \class PK_MessageAccumulatorBase /// \brief Interface for message encoding method for public key signature schemes. /// \details PK_MessageAccumulatorBase provides interfaces /// for message encoding method. @@ -484,7 +466,6 @@ public: bool m_empty; }; -/// \class PK_MessageAccumulatorImpl /// \brief Interface for message encoding method for public key signature schemes. /// \details PK_MessageAccumulatorBase provides interfaces /// for message encoding method. @@ -495,7 +476,6 @@ public: HashTransformation & AccessHash() {return this->m_object;} }; -/// \class TF_SignatureSchemeBase /// \brief Trapdoor Function (TF) Signature Scheme base class /// \tparam INTFACE interface /// \tparam BASE base class @@ -527,7 +507,6 @@ protected: virtual size_t GetDigestSize() const =0; }; -/// \class TF_SignerBase /// \brief Trapdoor Function (TF) Signer base class class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE TF_SignerBase : public TF_SignatureSchemeBase > { @@ -538,7 +517,6 @@ public: size_t SignAndRestart(RandomNumberGenerator &rng, PK_MessageAccumulator &messageAccumulator, byte *signature, bool restart=true) const; }; -/// \class TF_VerifierBase /// \brief Trapdoor Function (TF) Verifier base class class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE TF_VerifierBase : public TF_SignatureSchemeBase > { @@ -552,7 +530,6 @@ public: // ******************************************************** -/// \class TF_CryptoSchemeOptions /// \brief Trapdoor Function (TF) scheme options /// \tparam T1 algorithm info class /// \tparam T2 keys class with public and private key @@ -567,7 +544,6 @@ struct TF_CryptoSchemeOptions typedef T3 MessageEncodingMethod; }; -/// \class TF_SignatureSchemeOptions /// \brief Trapdoor Function (TF) signature scheme options /// \tparam T1 algorithm info class /// \tparam T2 keys class with public and private key @@ -579,7 +555,6 @@ struct TF_SignatureSchemeOptions : public TF_CryptoSchemeOptions typedef T4 HashFunction; }; -/// \class TF_ObjectImplBase /// \brief Trapdoor Function (TF) base implementation /// \tparam BASE base class /// \tparam SCHEME_OPTIONS scheme options class @@ -635,7 +610,6 @@ protected: } }; -/// \class TF_ObjectImplExtRef /// \brief Trapdoor Function (TF) signature with external reference /// \tparam BASE base class /// \tparam SCHEME_OPTIONS scheme options class @@ -657,7 +631,6 @@ private: const KEY * m_pKey; }; -/// \class TF_ObjectImpl /// \brief Trapdoor Function (TF) signature scheme options /// \tparam BASE base class /// \tparam SCHEME_OPTIONS scheme options class @@ -678,7 +651,6 @@ private: KeyClass m_trapdoorFunction; }; -/// \class TF_DecryptorImpl /// \brief Trapdoor Function (TF) decryptor options /// \tparam SCHEME_OPTIONS scheme options class template @@ -686,7 +658,6 @@ class TF_DecryptorImpl : public TF_ObjectImpl @@ -694,7 +665,6 @@ class TF_EncryptorImpl : public TF_ObjectImpl @@ -702,7 +672,6 @@ class TF_SignerImpl : public TF_ObjectImpl @@ -712,7 +681,6 @@ class TF_VerifierImpl : public TF_ObjectImpl @@ -1673,7 +1639,6 @@ protected: } }; -/// \class DL_VerifierBase /// \brief Discret Log (DL) Verifier base class /// \tparam T Field element template @@ -2256,7 +2221,6 @@ public: typedef PK_FinalTemplate > Encryptor; }; -/// \class TF_SS /// \brief Trapdoor Function (TF) Signature Scheme /// \tparam STANDARD standard /// \tparam H hash function @@ -2282,7 +2246,6 @@ public: typedef PK_FinalTemplate > Verifier; }; -/// \class DL_SS /// \brief Discrete Log (DL) signature scheme /// \tparam KEYS keys used in the signature scheme /// \tparam SA signature algorithm diff --git a/queue.h b/queue.h index 40ebb47b..f3f56002 100644 --- a/queue.h +++ b/queue.h @@ -13,7 +13,6 @@ NAMESPACE_BEGIN(CryptoPP) class ByteQueueNode; -/// \class ByteQueue /// \brief Data structure used to store byte strings /// \details The queue is implemented as a linked list of byte arrays class CRYPTOPP_DLL ByteQueue : public Bufferless @@ -73,7 +72,6 @@ public: byte operator[](lword i) const; void swap(ByteQueue &rhs); - /// \class Walker /// \brief A ByteQueue iterator class Walker : public InputRejecting { diff --git a/rabin.h b/rabin.h index ad476ea3..1cea7d45 100644 --- a/rabin.h +++ b/rabin.h @@ -13,7 +13,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RabinFunction /// \brief Rabin trapdoor function using the public key /// \since Crypto++ 2.0 class RabinFunction : public TrapdoorFunction, public PublicKey @@ -52,7 +51,6 @@ protected: Integer m_n, m_r, m_s; }; -/// \class InvertibleRabinFunction /// \brief Rabin trapdoor function using the private key /// \since Crypto++ 2.0 class InvertibleRabinFunction : public RabinFunction, public TrapdoorFunctionInverse, public PrivateKey diff --git a/randpool.h b/randpool.h index fafad343..cd823862 100644 --- a/randpool.h +++ b/randpool.h @@ -26,7 +26,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RandomPool /// \brief Randomness Pool based on AES-256 /// \details RandomPool can be used to generate cryptographic quality pseudorandom bytes /// after seeding the pool with IncorporateEntropy(). Internally, the generator uses @@ -56,7 +55,6 @@ private: bool m_keySet; }; -/// \class OldRandomPool /// \brief Randomness Pool based on PGP 2.6.x with MDC /// \details If you need the pre-Crypto++ 5.5 generator then use OldRandomPool class. The /// OldRandomPool class is always available so you dont need to define diff --git a/rc2.h b/rc2.h index 9a6541ad..8baf1288 100644 --- a/rc2.h +++ b/rc2.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RC2_Info /// \brief RC2 block cipher information struct RC2_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 1, 128> { @@ -21,12 +20,10 @@ struct RC2_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 1, 128> CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "RC2";} }; -/// \class RC2 /// \brief RC2 block cipher /// \sa RC2 on the Crypto Lounge. class RC2 : public RC2_Info, public BlockCipherDocumentation { - /// \class Base /// \brief Class specific methods used to operate the cipher. /// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl @@ -39,7 +36,6 @@ class RC2 : public RC2_Info, public BlockCipherDocumentation FixedSizeSecBlock K; // expanded key table }; - /// \class Enc /// \brief Class specific methods used to operate the cipher in the forward direction. /// \details Implementations and overrides in \p Enc apply to \p ENCRYPTION. class CRYPTOPP_NO_VTABLE Enc : public Base @@ -48,7 +44,6 @@ class RC2 : public RC2_Info, public BlockCipherDocumentation void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; - /// \class Dec /// \brief Class specific methods used to operate the cipher in the reverse direction. /// \details Implementations and overrides in \p Dec apply to \p DECRYPTION. class CRYPTOPP_NO_VTABLE Dec : public Base @@ -59,7 +54,6 @@ class RC2 : public RC2_Info, public BlockCipherDocumentation public: - /// \class Encryption /// \brief Class specific methods used to operate the cipher in the forward direction. /// \details Implementations and overrides in \p Encryption apply to \p ENCRYPTION. class Encryption : public BlockCipherFinal @@ -72,7 +66,6 @@ public: {SetKey(key, keyLen, MakeParameters("EffectiveKeyLength", effectiveKeyLen));} }; - /// \class Decryption /// \brief Class specific methods used to operate the cipher in the reverse direction. /// \details Implementations and overrides in \p Decryption apply to \p DECRYPTION. class Decryption : public BlockCipherFinal diff --git a/rc5.h b/rc5.h index 0089a3ec..af6b7233 100644 --- a/rc5.h +++ b/rc5.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RC5_Info /// \brief RC5 block cipher information /// \since Crypto++ 1.0 struct RC5_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 0, 255>, public VariableRounds<16> @@ -20,7 +19,6 @@ struct RC5_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 0, 255> typedef word32 RC5_WORD; }; -/// \class RC5 /// \brief RC5 block cipher /// \sa RC5 /// \since Crypto++ 1.0 diff --git a/rc6.h b/rc6.h index 4cc0978d..ce2227d6 100644 --- a/rc6.h +++ b/rc6.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RC6_Info /// \brief RC6 block cipher information struct RC6_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 8>, public VariableRounds<20> { @@ -19,7 +18,6 @@ struct RC6_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32 typedef word32 RC6_WORD; }; -/// \class RC6 /// \brief RC6 block cipher /// \sa RC6 class RC6 : public RC6_Info, public BlockCipherDocumentation diff --git a/ripemd.h b/ripemd.h index 1ffc5423..e1f5081f 100644 --- a/ripemd.h +++ b/ripemd.h @@ -10,7 +10,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RIPEMD160 /// \brief RIPEMD-160 message digest /// \details Digest size is 160-bits. /// \sa RIPEMD-160 @@ -22,7 +21,6 @@ public: CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "RIPEMD-160";} }; -/// \class RIPEMD320 /// \brief RIPEMD-320 message digest /// \details Digest size is 320-bits. /// \sa RIPEMD-320 @@ -34,7 +32,6 @@ public: CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "RIPEMD-320";} }; -/// \class RIPEMD128 /// \brief RIPEMD-128 message digest /// \details Digest size is 128-bits. /// \warning RIPEMD-128 is considered insecure, and should not be used unless you absolutely need it for compatibility. @@ -47,7 +44,6 @@ public: CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "RIPEMD-128";} }; -/// \class RIPEMD256 /// \brief RIPEMD-256 message digest /// \details Digest size is 256-bits. /// \warning RIPEMD-256 is considered insecure, and should not be used unless you absolutely need it for compatibility. diff --git a/rng.h b/rng.h index bde20947..a7a89243 100644 --- a/rng.h +++ b/rng.h @@ -40,7 +40,6 @@ private: static const word16 r; }; -/// \class X917RNG /// \brief ANSI X9.17 RNG /// \details X917RNG is from ANSI X9.17 Appendix C, and it uses a 64-bit block cipher, like TripleDES. /// If you use a 128-bit block cipher, like AES, then you are effectively using an ANSI X9.31 generator. @@ -75,7 +74,6 @@ private: SecByteBlock m_randseed, m_lastBlock, m_deterministicTimeVector; }; -/// \class MaurerRandomnessTest /// \brief Maurer's Universal Statistical Test for Random Bit Generators /// \details This class implements Maurer's Universal Statistical Test for /// Random Bit Generators. It is intended for measuring the randomness of diff --git a/rsa.h b/rsa.h index 63ef6303..62c1111e 100644 --- a/rsa.h +++ b/rsa.h @@ -18,7 +18,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RSAFunction /// \brief RSA trapdoor function using the public key /// \since Crypto++ 1.0 class CRYPTOPP_DLL RSAFunction : public TrapdoorFunction, public X509PublicKey @@ -58,7 +57,6 @@ protected: Integer m_n, m_e; }; -/// \class InvertibleRSAFunction /// \brief RSA trapdoor function using the private key /// \since Crypto++ 1.0 class CRYPTOPP_DLL InvertibleRSAFunction : public RSAFunction, public TrapdoorFunctionInverse, public PKCS8PrivateKey @@ -139,7 +137,6 @@ protected: Integer m_d, m_p, m_q, m_dp, m_dq, m_u; }; -/// \class RSAFunction_ISO /// \brief RSA trapdoor function using the public key /// \since Crypto++ 1.0 class CRYPTOPP_DLL RSAFunction_ISO : public RSAFunction @@ -149,7 +146,6 @@ public: Integer PreimageBound() const {return ++(m_n>>1);} }; -/// \class InvertibleRSAFunction_ISO /// \brief RSA trapdoor function using the private key /// \since Crypto++ 1.0 class CRYPTOPP_DLL InvertibleRSAFunction_ISO : public InvertibleRSAFunction @@ -159,7 +155,6 @@ public: Integer PreimageBound() const {return ++(m_n>>1);} }; -/// \class RSA /// \brief RSA algorithm /// \since Crypto++ 1.0 struct CRYPTOPP_DLL RSA @@ -169,7 +164,6 @@ struct CRYPTOPP_DLL RSA typedef InvertibleRSAFunction PrivateKey; }; -/// \class RSAES /// \brief RSA encryption algorithm /// \tparam STANDARD signature standard /// \sa RSA cryptosystem @@ -179,7 +173,6 @@ struct RSAES : public TF_ES { }; -/// \class RSASS /// \brief RSA signature algorithm /// \tparam STANDARD signature standard /// \tparam H hash transformation @@ -191,7 +184,6 @@ struct RSASS : public TF_SS { }; -/// \class RSA_ISO /// \brief RSA algorithm /// \since Crypto++ 1.0 struct CRYPTOPP_DLL RSA_ISO @@ -201,7 +193,6 @@ struct CRYPTOPP_DLL RSA_ISO typedef InvertibleRSAFunction_ISO PrivateKey; }; -/// \class RSASS_ISO /// \brief RSA signature algorithm /// \tparam H hash transformation /// \since Crypto++ 1.0 diff --git a/rw.h b/rw.h index f6274c9d..21f60d03 100644 --- a/rw.h +++ b/rw.h @@ -17,7 +17,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class RWFunction /// \brief Rabin-Williams trapdoor function using the public key /// \since Crypto++ 2.0, Tweaked roots using e and f since Crypto++ 5.6.4 class CRYPTOPP_DLL RWFunction : public TrapdoorFunction, public PublicKey @@ -54,7 +53,6 @@ protected: Integer m_n; }; -/// \class InvertibleRWFunction /// \brief Rabin-Williams trapdoor function using the private key /// \since Crypto++ 2.0, Tweaked roots using e and f since Crypto++ 5.6.4 class CRYPTOPP_DLL InvertibleRWFunction : public RWFunction, public TrapdoorFunctionInverse, public PrivateKey diff --git a/safer.h b/safer.h index 78d3e1e3..b28ad82c 100644 --- a/safer.h +++ b/safer.h @@ -11,12 +11,10 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SAFER /// \brief SAFER block cipher class SAFER { public: - /// \class Base /// \brief SAFER block cipher default operation class CRYPTOPP_NO_VTABLE Base : public BlockCipher { @@ -32,7 +30,6 @@ public: static const byte log_tab[256]; }; - /// \class Enc /// \brief SAFER block cipher encryption operation class CRYPTOPP_NO_VTABLE Enc : public Base { @@ -40,7 +37,6 @@ public: void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; - /// \class Dec /// \brief SAFER block cipher decryption operation class CRYPTOPP_NO_VTABLE Dec : public Base { @@ -49,7 +45,6 @@ public: }; }; -/// \class SAFER_Impl /// \brief SAFER block cipher default implementation /// \tparam BASE SAFER::Enc or SAFER::Dec derived base class /// \tparam INFO SAFER_Info derived class @@ -62,14 +57,12 @@ protected: bool Strengthened() const {return STR;} }; -/// \class SAFER_K_Info /// \brief SAFER-K block cipher information struct SAFER_K_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 8, 16, 8>, public VariableRounds<10, 1, 13> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "SAFER-K";} }; -/// \class SAFER_K /// \brief SAFER-K block cipher /// \sa SAFER-K class SAFER_K : public SAFER_K_Info, public SAFER, public BlockCipherDocumentation @@ -79,14 +72,12 @@ public: typedef BlockCipherFinal > Decryption; }; -/// \class SAFER_SK_Info /// \brief SAFER-SK block cipher information struct SAFER_SK_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 8, 16, 8>, public VariableRounds<10, 1, 13> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "SAFER-SK";} }; -/// \class SAFER_SK /// \brief SAFER-SK block cipher /// \sa SAFER-SK class SAFER_SK : public SAFER_SK_Info, public SAFER, public BlockCipherDocumentation diff --git a/salsa.h b/salsa.h index db3c469a..fcbfd994 100644 --- a/salsa.h +++ b/salsa.h @@ -16,14 +16,12 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Salsa20_Info /// \brief Salsa20 stream cipher information struct Salsa20_Info : public VariableKeyLength<32, 16, 32, 16, SimpleKeyingInterface::UNIQUE_IV, 8> { static std::string StaticAlgorithmName() {return "Salsa20";} }; -/// \class Salsa20_Policy /// \brief Salsa20 stream cipher operation class CRYPTOPP_NO_VTABLE Salsa20_Policy : public AdditiveCipherConcretePolicy { @@ -42,7 +40,6 @@ protected: int m_rounds; }; -/// \class Salsa20 /// \brief Salsa20 stream cipher /// \details Salsa20 provides a variable number of rounds: 8, 12 or 20. The default number of rounds is 20. /// \sa XSalsa20 @@ -52,14 +49,12 @@ struct Salsa20 : public Salsa20_Info, public SymmetricCipherDocumentation typedef Encryption Decryption; }; -/// \class XSalsa20_Info /// \brief XSalsa20 stream cipher information struct XSalsa20_Info : public FixedKeyLength<32, SimpleKeyingInterface::UNIQUE_IV, 24> { static std::string StaticAlgorithmName() {return "XSalsa20";} }; -/// \class XSalsa20_Policy /// \brief XSalsa20 stream cipher operation class CRYPTOPP_NO_VTABLE XSalsa20_Policy : public Salsa20_Policy { @@ -71,7 +66,6 @@ protected: FixedSizeSecBlock m_key; }; -/// \class XSalsa20 /// \brief XSalsa20 stream cipher /// \details XSalsa20 provides a variable number of rounds: 8, 12 or 20. The default number of rounds is 20. /// \sa XSalsa20 diff --git a/seal.h b/seal.h index c8a24951..861bd35c 100644 --- a/seal.h +++ b/seal.h @@ -11,7 +11,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SEAL_Info /// \brief SEAL stream cipher information /// \tparam B Endianness of the stream cipher template @@ -20,7 +19,6 @@ struct SEAL_Info : public FixedKeyLength<20, SimpleKeyingInterface::INTERNALLY_G CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return B::ToEnum() == LITTLE_ENDIAN_ORDER ? "SEAL-3.0-LE" : "SEAL-3.0-BE";} }; -/// \class SEAL_Policy /// \brief SEAL stream cipher operation /// \tparam B Endianness of the stream cipher template @@ -42,7 +40,6 @@ private: word32 m_outsideCounter, m_insideCounter; }; -/// \class SEAL /// \brief SEAL stream cipher /// \tparam B Endianness of the stream cipher /// \sa SEAL diff --git a/secblock.h b/secblock.h index 123546e2..2840030a 100644 --- a/secblock.h +++ b/secblock.h @@ -22,7 +22,6 @@ NAMESPACE_BEGIN(CryptoPP) // ************** secure memory allocation *************** -/// \class AllocatorBase /// \brief Base class for all allocators used by SecBlock /// \tparam T the class or type template @@ -160,7 +159,6 @@ typename A::pointer StandardReallocate(A& alloc, T *oldPtr, typename A::size_typ } } -/// \class AllocatorWithCleanup /// \brief Allocates a block of memory with cleanup /// \tparam T class or type /// \tparam T_Align16 boolean that determines whether allocations should be aligned on a 16-byte boundary @@ -273,7 +271,6 @@ CRYPTOPP_DLL_TEMPLATE_CLASS AllocatorWithCleanup; // for Integer CRYPTOPP_DLL_TEMPLATE_CLASS AllocatorWithCleanup; // for Integer #endif -/// \class NullAllocator /// \brief NULL allocator /// \tparam T class or type /// \details A NullAllocator is useful for fixed-size, stack based allocations @@ -307,7 +304,6 @@ public: //LCOV_EXCL_STOP }; -/// \class FixedSizeAllocatorWithCleanup /// \brief Static secure memory block with cleanup /// \tparam T class or type /// \tparam S fixed-size of the stack-based memory block, in elements @@ -451,7 +447,6 @@ private: bool m_allocated; }; -/// \class SecBlock /// \brief Secure memory block with allocator and cleanup /// \tparam T a class or type /// \tparam A AllocatorWithCleanup derived class for allocation and cleanup @@ -823,13 +818,10 @@ protected: }; #ifdef CRYPTOPP_DOXYGEN_PROCESSING -/// \class SecByteBlock /// \brief \ref SecBlock "SecBlock" typedef. class SecByteBlock : public SecBlock {}; -/// \class SecWordBlock /// \brief \ref SecBlock "SecBlock" typedef. class SecWordBlock : public SecBlock {}; -/// \class AlignedSecByteBlock /// \brief SecBlock using \ref AllocatorWithCleanup "AllocatorWithCleanup" typedef class AlignedSecByteBlock : public SecBlock > {}; #else @@ -841,7 +833,6 @@ typedef SecBlock > AlignedSecByteBlock; // No need for move semantics on derived class *if* the class does not add any // data members; see http://stackoverflow.com/q/31755703, and Rule of {0|3|5}. -/// \class FixedSizeSecBlock /// \brief Fixed size stack-based SecBlock /// \tparam T class or type /// \tparam S fixed-size of the stack-based memory block, in elements @@ -854,7 +845,6 @@ public: explicit FixedSizeSecBlock() : SecBlock(S) {} }; -/// \class FixedSizeAlignedSecBlock /// \brief Fixed size stack-based SecBlock with 16-byte alignment /// \tparam T class or type /// \tparam S fixed-size of the stack-based memory block, in elements @@ -864,7 +854,6 @@ class FixedSizeAlignedSecBlock : public FixedSizeSecBlock @@ -69,7 +68,6 @@ public: // ************** rounds *************** -/// \class FixedRounds /// \brief Inherited by algorithms with fixed number of rounds /// \tparam R the number of rounds used by the algorithm template @@ -80,7 +78,6 @@ public: CRYPTOPP_CONSTANT(ROUNDS = R) }; -/// \class VariableRounds /// \brief Inherited by algorithms with variable number of rounds /// \tparam D Default number of rounds /// \tparam N Minimum number of rounds @@ -140,7 +137,6 @@ protected: // ************** key length *************** -/// \class FixedKeyLength /// \brief Inherited by keyed algorithms with fixed key length /// \tparam N Default key length, in bytes /// \tparam IV_REQ the \ref SimpleKeyingInterface::IV_Requirement "IV requirements" @@ -179,7 +175,6 @@ public: } }; -/// \class VariableKeyLength /// \brief Inherited by keyed algorithms with variable key length /// \tparam D Default key length, in bytes /// \tparam N Minimum key length, in bytes @@ -235,7 +230,6 @@ public: } }; -/// \class SameKeyLengthAs /// \brief Provides key lengths based on another class's key length /// \tparam T another FixedKeyLength or VariableKeyLength class /// \tparam IV_REQ the \ref SimpleKeyingInterface::IV_Requirement "IV requirements" @@ -275,7 +269,6 @@ public: // ************** implementation helper for SimpleKeyingInterface *************** -/// \class SimpleKeyingInterfaceImpl /// \brief Provides a base implementation of SimpleKeyingInterface /// \tparam BASE a SimpleKeyingInterface derived class /// \tparam INFO a SimpleKeyingInterface derived class @@ -323,7 +316,6 @@ public: {return INFO::IV_LENGTH;} }; -/// \class BlockCipherImpl /// \brief Provides a base implementation of Algorithm and SimpleKeyingInterface for block ciphers /// \tparam INFO a SimpleKeyingInterface derived class /// \tparam BASE a SimpleKeyingInterface derived class @@ -339,7 +331,6 @@ public: unsigned int BlockSize() const {return this->BLOCKSIZE;} }; -/// \class BlockCipherFinal /// \brief Provides class member functions to key a block cipher /// \tparam DIR a CipherDir /// \tparam BASE a BlockCipherImpl derived class @@ -381,7 +372,6 @@ public: bool IsForwardTransformation() const {return DIR == ENCRYPTION;} }; -/// \class MessageAuthenticationCodeImpl /// \brief Provides a base implementation of Algorithm and SimpleKeyingInterface for message authentication codes /// \tparam INFO a SimpleKeyingInterface derived class /// \tparam BASE a SimpleKeyingInterface derived class @@ -394,7 +384,6 @@ class MessageAuthenticationCodeImpl : public AlgorithmImpl, public FixedKeyLength<16>, public FixedRounds<16> @@ -20,7 +19,6 @@ struct SEED_Info : public FixedBlockSize<16>, public FixedKeyLength<16>, public CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "SEED";} }; -/// \class SEED /// \brief SEED block cipher /// \sa SEED /// \since Crypto++ 5.6.0 diff --git a/serpent.h b/serpent.h index 277887f3..37d53995 100644 --- a/serpent.h +++ b/serpent.h @@ -11,14 +11,12 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Serpent_Info /// \brief Serpent block cipher information struct Serpent_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 8>, public FixedRounds<32> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "Serpent";} }; -/// \class Serpent /// \brief Serpent block cipher /// \sa Serpent class Serpent : public Serpent_Info, public BlockCipherDocumentation diff --git a/sha.h b/sha.h index 06563002..646f4c60 100644 --- a/sha.h +++ b/sha.h @@ -19,7 +19,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SHA1 /// \brief SHA-1 message digest /// \sa SHA-1 /// \since Crypto++ 1.0, Intel SHA extensions since Crypto++ 6.0 @@ -55,7 +54,6 @@ protected: size_t HashMultipleBlocks(const HashWordType *input, size_t length); }; -/// \class SHA256 /// \brief SHA-256 message digest /// \sa SHA-256 /// \since Crypto++ 4.0, Intel SHA extensions since Crypto++ 6.0 @@ -91,7 +89,6 @@ protected: size_t HashMultipleBlocks(const HashWordType *input, size_t length); }; -/// \class SHA224 /// \brief SHA-224 message digest /// \sa SHA-224 /// \since Crypto++ 4.0, Intel SHA extensions since Crypto++ 6.0 @@ -127,7 +124,6 @@ protected: size_t HashMultipleBlocks(const HashWordType *input, size_t length); }; -/// \class SHA512 /// \brief SHA-512 message digest /// \sa SHA-512 /// \since Crypto++ 4.0 @@ -160,7 +156,6 @@ public: CRYPTOPP_STATIC_CONSTEXPR const char* CRYPTOPP_API StaticAlgorithmName() {return "SHA-512";} }; -/// \class SHA384 /// \brief SHA-384 message digest /// \sa SHA-384 /// \since Crypto++ 4.0 diff --git a/sha3.h b/sha3.h index ca07a678..fe1fe21a 100644 --- a/sha3.h +++ b/sha3.h @@ -16,7 +16,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SHA3 /// \brief SHA3 message digest base class /// \details The Crypto++ implementation conforms to FIPS 202 version of SHA3 using F1600 with XOF d=0x06. /// Previous behavior (XOF d=0x01) is available in Keccak classes. @@ -51,7 +50,6 @@ protected: unsigned int m_digestSize, m_counter; }; -/// \class SHA3_Final /// \brief SHA3 message digest template /// \tparam T_DigestSize the size of the digest, in bytes /// \since Crypto++ 5.6.2 diff --git a/shacal2.h b/shacal2.h index f2d6adb0..20cb306c 100644 --- a/shacal2.h +++ b/shacal2.h @@ -12,14 +12,12 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SHACAL2_Info /// \brief SHACAL2 block cipher information struct SHACAL2_Info : public FixedBlockSize<32>, public VariableKeyLength<16, 16, 64> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "SHACAL-2";} }; -/// \class SHACAL2 /// \brief SHACAL2 block cipher /// \since Crypto++ 5.2, Intel SHA since Crypto++ 6.0 /// \sa SHACAL-2 diff --git a/shark.h b/shark.h index a39c47a0..4072667f 100644 --- a/shark.h +++ b/shark.h @@ -12,19 +12,16 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SHARK_Info /// \brief SHARK block cipher information struct SHARK_Info : public FixedBlockSize<8>, public FixedKeyLength<16>, public VariableRounds<6, 2> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "SHARK-E";} }; -/// \class SHARK /// \brief SHARK block cipher /// SHARK-E class SHARK : public SHARK_Info, public BlockCipherDocumentation { - /// \class Base /// \brief SHARK block cipher default operation class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { @@ -36,7 +33,6 @@ class SHARK : public SHARK_Info, public BlockCipherDocumentation SecBlock m_roundKeys; }; - /// \class Enc /// \brief SHARK block cipher encryption operation class CRYPTOPP_NO_VTABLE Enc : public Base { @@ -51,7 +47,6 @@ class SHARK : public SHARK_Info, public BlockCipherDocumentation static const word64 cbox[8][256]; }; - /// \class Dec /// \brief SHARK block cipher decryption operation class CRYPTOPP_NO_VTABLE Dec : public Base { diff --git a/simon.h b/simon.h index 43d06355..896e714b 100644 --- a/simon.h +++ b/simon.h @@ -26,7 +26,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SIMON_Info /// \brief SIMON block cipher information /// \tparam L block size of the cipher, in bytes /// \tparam D default key length, in bytes @@ -43,7 +42,6 @@ struct SIMON_Info : public FixedBlockSize, VariableKeyLength } }; -/// \class SIMON_Base /// \brief SIMON block cipher base class /// \tparam W the word type /// \details User code should use SIMON64 or SIMON128 @@ -62,7 +60,6 @@ SIMON_Base() : m_kwords(0), m_rounds(0) {} unsigned int m_rounds; // number of rounds }; -/// \class SIMON64 /// \brief SIMON 64-bit block cipher /// \details Simon is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith, /// Stefan Treatman-Clark, Bryan Weeks and Louis Wingers. @@ -120,7 +117,6 @@ public: typedef BlockCipherFinal Decryption; }; -/// \class SIMON128 /// \brief SIMON 128-bit block cipher /// \details Simon is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith, /// Stefan Treatman-Clark, Bryan Weeks and Louis Wingers. diff --git a/simple.h b/simple.h index ea8d6748..a8c652c5 100644 --- a/simple.h +++ b/simple.h @@ -18,7 +18,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class ClonableImpl /// \brief Base class for identifying alogorithm /// \tparam BASE base class from which to derive /// \tparam DERIVED class which to clone @@ -29,7 +28,6 @@ public: Clonable * Clone() const {return new DERIVED(*static_cast(this));} }; -/// \class AlgorithmImpl /// \brief Base class information /// \tparam BASE an Algorithm derived class /// \tparam ALGORITHM_INFO an Algorithm derived class @@ -50,7 +48,6 @@ public: std::string AlgorithmName() const {return ALGORITHM_INFO::StaticAlgorithmName();} }; -/// \class InvalidKeyLength /// \brief Exception thrown when an invalid key length is encountered class CRYPTOPP_DLL InvalidKeyLength : public InvalidArgument { @@ -58,7 +55,6 @@ public: explicit InvalidKeyLength(const std::string &algorithm, size_t length) : InvalidArgument(algorithm + ": " + IntToString(length) + " is not a valid key length") {} }; -/// \class InvalidRounds /// \brief Exception thrown when an invalid number of rounds is encountered class CRYPTOPP_DLL InvalidRounds : public InvalidArgument { @@ -66,7 +62,6 @@ public: explicit InvalidRounds(const std::string &algorithm, unsigned int rounds) : InvalidArgument(algorithm + ": " + IntToString(rounds) + " is not a valid number of rounds") {} }; -/// \class InvalidBlockSize /// \brief Exception thrown when an invalid block size is encountered class CRYPTOPP_DLL InvalidBlockSize : public InvalidArgument { @@ -74,7 +69,6 @@ public: explicit InvalidBlockSize(const std::string &algorithm, size_t length) : InvalidArgument(algorithm + ": " + IntToString(length) + " is not a valid block size") {} }; -/// \class InvalidPersonalizationLength /// \brief Exception thrown when an invalid personalization string length is encountered class CRYPTOPP_DLL InvalidPersonalizationLength : public InvalidArgument { @@ -82,7 +76,6 @@ public: explicit InvalidPersonalizationLength(const std::string &algorithm, size_t length) : InvalidArgument(algorithm + ": " + IntToString(length) + " is not a valid salt length") {} }; -/// \class InvalidSaltLength /// \brief Exception thrown when an invalid salt length is encountered class CRYPTOPP_DLL InvalidSaltLength : public InvalidArgument { @@ -92,7 +85,6 @@ public: // ***************************** -/// \class Bufferless /// \brief Base class for bufferless filters /// \tparam T the class or type template @@ -103,7 +95,6 @@ public: {CRYPTOPP_UNUSED(hardFlush); CRYPTOPP_UNUSED(blocking); return false;} }; -/// \class Unflushable /// \brief Base class for unflushable filters /// \tparam T the class or type template @@ -129,7 +120,6 @@ protected: virtual bool InputBufferIsEmpty() const {return false;} }; -/// \class InputRejecting /// \brief Base class for input rejecting filters /// \tparam T the class or type /// \details T should be a BufferedTransformation derived class @@ -168,7 +158,6 @@ public: //@} }; -/// \class CustomFlushPropagation /// \brief Interface for custom flush signals propagation /// \tparam T BufferedTransformation derived class template @@ -201,7 +190,6 @@ private: {CRYPTOPP_UNUSED(hardFlush); CRYPTOPP_UNUSED(blocking); CRYPTOPP_ASSERT(false); return false;} }; -/// \class CustomSignalPropagation /// \brief Interface for custom flush signals /// \tparam T BufferedTransformation derived class template @@ -223,7 +211,6 @@ private: {CRYPTOPP_UNUSED(parameters); CRYPTOPP_ASSERT(false);} }; -/// \class Multichannel /// \brief Multiple channels support for custom signal processing /// \tparam T the class or type /// \details T should be a BufferedTransformation derived class @@ -289,7 +276,6 @@ public: virtual bool ChannelFlush(const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true) =0; }; -/// \class AutoSignaling /// \brief Provides auto signaling support /// \tparam T BufferedTransformation derived class template @@ -309,7 +295,6 @@ private: int m_autoSignalPropagation; }; -/// \class Store /// \brief Acts as a Source for pre-existing, static data class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Store : public AutoSignaling > { @@ -333,7 +318,6 @@ protected: bool m_messageEnd; }; -/// \class Sink /// \brief Implementation of BufferedTransformation's attachment interface /// \details Sink is a cornerstone of the Pipeline trinitiy. Data flows from /// Sources, through Filters, and then terminates in Sinks. The difference @@ -352,7 +336,6 @@ public: {CRYPTOPP_UNUSED(target); CRYPTOPP_UNUSED(begin); CRYPTOPP_UNUSED(end); CRYPTOPP_UNUSED(channel); CRYPTOPP_UNUSED(blocking); return 0;} }; -/// \class BitBucket /// \brief Acts as an input discarding Filter or Sink /// \details The BitBucket discards all input and returns 0 to the caller /// to indicate all data was processed. diff --git a/siphash.h b/siphash.h index 9bd190a4..a7fbd524 100644 --- a/siphash.h +++ b/siphash.h @@ -32,7 +32,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SipHash_Info /// \brief SipHash message authentication code information /// \tparam T_128bit flag indicating 128-bit (true) versus 64-bit (false) digest size template @@ -43,7 +42,6 @@ public: CRYPTOPP_CONSTANT(DIGESTSIZE = (T_128bit ? 16 : 8)) }; -/// \class SipHash_Base /// \brief SipHash message authentication code base class /// \tparam C the number of compression rounds /// \tparam D the number of finalization rounds @@ -115,7 +113,6 @@ private: size_t m_idx; }; -/// \class SipHash /// \brief SipHash message authentication code /// \tparam C the number of compression rounds /// \tparam D the number of finalization rounds diff --git a/skipjack.h b/skipjack.h index 01743224..0775cd7c 100644 --- a/skipjack.h +++ b/skipjack.h @@ -11,19 +11,16 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SKIPJACK_Info /// \brief SKIPJACK block cipher information struct SKIPJACK_Info : public FixedBlockSize<8>, public FixedKeyLength<10> { CRYPTOPP_DLL static const char * CRYPTOPP_API StaticAlgorithmName() {return "SKIPJACK";} }; -/// \class SKIPJACK /// \brief SKIPJACK block cipher /// \sa SKIPJACK class SKIPJACK : public SKIPJACK_Info, public BlockCipherDocumentation { - /// \class Base /// \brief SKIPJACK block cipher default operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { @@ -37,7 +34,6 @@ class SKIPJACK : public SKIPJACK_Info, public BlockCipherDocumentation FixedSizeSecBlock tab; }; - /// \class Enc /// \brief SKIPJACK block cipher encryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Enc : public Base { @@ -48,7 +44,6 @@ class SKIPJACK : public SKIPJACK_Info, public BlockCipherDocumentation static const word32 Te[4][256]; }; - /// \class Dec /// \brief SKIPJACK block cipher decryption operation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Dec : public Base { diff --git a/sm3.h b/sm3.h index 8bfd09e9..14f5fb10 100644 --- a/sm3.h +++ b/sm3.h @@ -19,7 +19,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SM3 /// \brief SM3 hash function /// \details SM3 is a hash function designed by Xiaoyun Wang, et al. The hash is part of the /// Chinese State Cryptography Administration portfolio. diff --git a/sm4.h b/sm4.h index 906dad7e..b979b35b 100644 --- a/sm4.h +++ b/sm4.h @@ -17,7 +17,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SM4_Info /// \brief SM4 block cipher information /// \since Crypto++ 6.0 struct SM4_Info : public FixedBlockSize<16>, FixedKeyLength<16> @@ -28,7 +27,6 @@ struct SM4_Info : public FixedBlockSize<16>, FixedKeyLength<16> } }; -/// \class SM4 /// \brief Classes for the SM4 block cipher /// \details SM4 is a block cipher designed by Xiaoyun Wang, et al. The block cipher is part of the /// Chinese State Cryptography Administration portfolio. The cipher was formely known as SMS4. diff --git a/smartptr.h b/smartptr.h index e5ee7705..783e2503 100644 --- a/smartptr.h +++ b/smartptr.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class simple_ptr /// \brief Manages resources for a single object /// \tparam T class or type /// \details \p simple_ptr is used frequently in the library to manage resources and @@ -30,7 +29,6 @@ public: T *m_p; }; -/// \class member_ptr /// \brief Pointer that overloads operator -> /// \tparam T class or type /// \details member_ptr is used frequently in the library to avoid the issues related to @@ -73,7 +71,6 @@ template void member_ptr::reset(T *p) {delete m_p; m_p = p;} // ******************************************************** -/// \class value_ptr /// \brief Value pointer /// \tparam T class or type template class value_ptr : public member_ptr @@ -101,7 +98,6 @@ template value_ptr& value_ptr::operator=(const value_ptr& rhs // ******************************************************** -/// \class clonable_ptr /// \brief A pointer which can be copied and cloned /// \tparam T class or type /// \details \p T should adhere to the \p Clonable interface @@ -126,7 +122,6 @@ template clonable_ptr& clonable_ptr::operator=(const clonable_pt // ******************************************************** -/// \class counted_ptr /// \brief Reference counted pointer /// \tparam T class or type /// \details users should declare \p m_referenceCount as std::atomic @@ -220,7 +215,6 @@ template counted_ptr & counted_ptr::operator=(const counted_ptr< // ******************************************************** -/// \class vector_ptr /// \brief Manages resources for an array of objects /// \tparam T class or type /// \details \p vector_ptr is used frequently in the library to avoid large stack allocations, @@ -278,7 +272,6 @@ private: // ******************************************************** -/// \class vector_member_ptrs /// \brief Manages resources for an array of objects /// \tparam T class or type template class vector_member_ptrs diff --git a/sosemanuk.h b/sosemanuk.h index a3f590c0..f832bcc7 100644 --- a/sosemanuk.h +++ b/sosemanuk.h @@ -18,7 +18,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SosemanukInfo /// \brief Sosemanuk stream cipher information /// \since Crypto++ 5.5 struct SosemanukInfo : public VariableKeyLength<16, 1, 32, 1, SimpleKeyingInterface::UNIQUE_IV, 16> @@ -26,7 +25,6 @@ struct SosemanukInfo : public VariableKeyLength<16, 1, 32, 1, SimpleKeyingInterf CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "Sosemanuk";} }; -/// \class SosemanukPolicy /// \brief Sosemanuk stream cipher implementation /// \since Crypto++ 5.5 class SosemanukPolicy : public AdditiveCipherConcretePolicy, public SosemanukInfo @@ -45,7 +43,6 @@ protected: FixedSizeAlignedSecBlock m_state; }; -/// \class Sosemanuk /// \brief Sosemanuk stream cipher /// \details is a stream cipher developed by Come Berbain, Olivier Billet, Anne Canteaut, Nicolas Courtois, /// Henri Gilbert, Louis Goubin, Aline Gouget, Louis Granboulan, Cédric Lauradoux, Marine Minier, Thomas diff --git a/speck.h b/speck.h index 6571074e..88f87d3b 100644 --- a/speck.h +++ b/speck.h @@ -26,7 +26,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class SPECK_Info /// \brief SPECK block cipher information /// \tparam L block size of the cipher, in bytes /// \tparam D default key length, in bytes @@ -43,7 +42,6 @@ struct SPECK_Info : public FixedBlockSize, VariableKeyLength } }; -/// \class SPECK_Base /// \brief SPECK block cipher base class /// \tparam W the word type /// \details User code should use SPECK64 or SPECK128 @@ -62,7 +60,6 @@ struct SPECK_Base unsigned int m_rounds; // number of rounds }; -/// \class SPECK64 /// \brief SPECK 64-bit block cipher /// \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith, /// Stefan Treatman-Clark, Bryan Weeks and Louis Wingers. @@ -120,7 +117,6 @@ public: typedef BlockCipherFinal Decryption; }; -/// \class SPECK128 /// \brief SPECK 128-bit block cipher /// \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith, /// Stefan Treatman-Clark, Bryan Weeks and Louis Wingers. diff --git a/square.h b/square.h index 5e0147bf..f1e9ee2c 100644 --- a/square.h +++ b/square.h @@ -11,14 +11,12 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Square_Info /// \brief Square block cipher information struct Square_Info : public FixedBlockSize<16>, public FixedKeyLength<16>, FixedRounds<8> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "Square";} }; -/// \class Square /// \brief Square block cipher /// \sa Square class Square : public Square_Info, public BlockCipherDocumentation diff --git a/strciphr.h b/strciphr.h index 30f581fa..3697ddf3 100644 --- a/strciphr.h +++ b/strciphr.h @@ -42,7 +42,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class AbstractPolicyHolder /// \brief Access a stream cipher policy object /// \tparam POLICY_INTERFACE class implementing AbstractPolicyHolder /// \tparam BASE class or type to use as a base class @@ -58,7 +57,6 @@ protected: virtual POLICY_INTERFACE & AccessPolicy() =0; }; -/// \class ConcretePolicyHolder /// \brief Stream cipher policy object /// \tparam POLICY class implementing AbstractPolicyHolder /// \tparam BASE class or type to use as a base class @@ -101,7 +99,6 @@ enum KeystreamOperation { /// \brief XOR the aligned input buffer and keystream, write to the aligned output buffer XOR_KEYSTREAM_BOTH_ALIGNED = OUTPUT_ALIGNED | INPUT_ALIGNED}; -/// \class AdditiveCipherAbstractPolicy /// \brief Policy object for additive stream ciphers struct CRYPTOPP_DLL CRYPTOPP_NO_VTABLE AdditiveCipherAbstractPolicy { @@ -175,7 +172,6 @@ struct CRYPTOPP_DLL CRYPTOPP_NO_VTABLE AdditiveCipherAbstractPolicy {CRYPTOPP_UNUSED(iterationCount); CRYPTOPP_ASSERT(!CipherIsRandomAccess()); throw NotImplemented("StreamTransformation: this object doesn't support random access");} }; -/// \class AdditiveCipherConcretePolicy /// \brief Base class for additive stream ciphers /// \tparam WT word type /// \tparam W count of words @@ -259,7 +255,6 @@ struct CRYPTOPP_NO_VTABLE AdditiveCipherConcretePolicy : public BASE } \ output += y; -/// \class AdditiveCipherTemplate /// \brief Base class for additive stream ciphers with SymmetricCipher interface /// \tparam BASE AbstractPolicyHolder base class template > @@ -344,7 +339,6 @@ protected: size_t m_leftOver; }; -/// \class CFB_CipherAbstractPolicy /// \brief Policy object for feeback based stream ciphers class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CFB_CipherAbstractPolicy { @@ -396,7 +390,6 @@ public: {CRYPTOPP_UNUSED(iv); CRYPTOPP_UNUSED(length); throw NotImplemented("SimpleKeyingInterface: this object doesn't support resynchronization");} }; -/// \class CFB_CipherConcretePolicy /// \brief Base class for feedback based stream ciphers /// \tparam WT word type /// \tparam W count of words @@ -481,7 +474,6 @@ struct CRYPTOPP_NO_VTABLE CFB_CipherConcretePolicy : public BASE }; }; -/// \class CFB_CipherTemplate /// \brief Base class for feedback based stream ciphers with SymmetricCipher interface /// \tparam BASE AbstractPolicyHolder base class template @@ -544,7 +536,6 @@ protected: size_t m_leftOver; }; -/// \class CFB_EncryptionTemplate /// \brief Base class for feedback based stream ciphers in the forward direction with SymmetricCipher interface /// \tparam BASE AbstractPolicyHolder base class template > @@ -554,7 +545,6 @@ class CRYPTOPP_NO_VTABLE CFB_EncryptionTemplate : public CFB_CipherTemplate > @@ -564,7 +554,6 @@ class CRYPTOPP_NO_VTABLE CFB_DecryptionTemplate : public CFB_CipherTemplate @@ -574,7 +563,6 @@ public: unsigned int MandatoryBlockSize() const {return this->OptimalBlockSize();} }; -/// \class SymmetricCipherFinal /// \brief SymmetricCipher implementation /// \tparam BASE AbstractPolicyHolder derived base class /// \tparam INFO AbstractPolicyHolder derived information class diff --git a/tea.h b/tea.h index ba1ad50e..7188724e 100644 --- a/tea.h +++ b/tea.h @@ -12,19 +12,16 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class TEA_Info /// \brief TEA block cipher information struct TEA_Info : public FixedBlockSize<8>, public FixedKeyLength<16>, public VariableRounds<32> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "TEA";} }; -/// \class TEA /// \brief TEA block cipher /// \sa TEA class TEA : public TEA_Info, public BlockCipherDocumentation { - /// \class Base /// \brief TEA block cipher default operation class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { @@ -36,7 +33,6 @@ class TEA : public TEA_Info, public BlockCipherDocumentation word32 m_limit; }; - /// \class Enc /// \brief TEA block cipher encryption operation class CRYPTOPP_NO_VTABLE Enc : public Base { @@ -44,7 +40,6 @@ class TEA : public TEA_Info, public BlockCipherDocumentation void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; - /// \class Dec /// \brief TEA block cipher decryption operation class CRYPTOPP_NO_VTABLE Dec : public Base { @@ -60,19 +55,16 @@ public: typedef TEA::Encryption TEAEncryption; typedef TEA::Decryption TEADecryption; -/// \class XTEA_Info /// \brief XTEA block cipher information struct XTEA_Info : public FixedBlockSize<8>, public FixedKeyLength<16>, public VariableRounds<32> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "XTEA";} }; -/// \class XTEA /// \brief XTEA block cipher /// \sa XTEA class XTEA : public XTEA_Info, public BlockCipherDocumentation { - /// \class Base /// \brief XTEA block cipher default operation class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { @@ -84,7 +76,6 @@ class XTEA : public XTEA_Info, public BlockCipherDocumentation word32 m_limit; }; - /// \class Enc /// \brief XTEA block cipher encryption operation class CRYPTOPP_NO_VTABLE Enc : public Base { @@ -92,7 +83,6 @@ class XTEA : public XTEA_Info, public BlockCipherDocumentation void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; - /// \class Dec /// \brief XTEA block cipher decryption operation class CRYPTOPP_NO_VTABLE Dec : public Base { @@ -105,20 +95,17 @@ public: typedef BlockCipherFinal Decryption; }; -/// \class BTEA_Info /// \brief BTEA block cipher information struct BTEA_Info : public FixedKeyLength<16> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "BTEA";} }; -/// \class BTEA /// \brief BTEA block cipher /// \details Corrected Block TEA as described in "xxtea". This class hasn't been tested yet. /// \sa Corrected Block TEA. class BTEA : public BTEA_Info, public BlockCipherDocumentation { - /// \class Base /// \brief BTEA block cipher default operation class CRYPTOPP_NO_VTABLE Base : public AlgorithmImpl, BTEA_Info>, public BTEA_Info { @@ -137,7 +124,6 @@ class BTEA : public BTEA_Info, public BlockCipherDocumentation unsigned int m_blockSize; }; - /// \class Enc /// \brief BTEA block cipher encryption operation class CRYPTOPP_NO_VTABLE Enc : public Base { @@ -145,7 +131,6 @@ class BTEA : public BTEA_Info, public BlockCipherDocumentation void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; - /// \class Dec /// \brief BTEA block cipher decryption operation class CRYPTOPP_NO_VTABLE Dec : public Base { diff --git a/threefish.h b/threefish.h index c1e5672e..d78d4219 100644 --- a/threefish.h +++ b/threefish.h @@ -18,7 +18,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Threefish_Info /// \brief Threefish block cipher information /// \tparam BS block size of the cipher, in bytes /// \since Crypto++ 6.0 @@ -32,7 +31,6 @@ struct Threefish_Info : public FixedBlockSize, FixedKeyLength } }; -/// \class Threefish_Base /// \brief Threefish block cipher base class /// \tparam BS block size of the cipher, in bytes /// \details User code should use Threefish256, Threefish512, Threefish1024 @@ -66,7 +64,6 @@ struct CRYPTOPP_NO_VTABLE Threefish_Base AlignedSecBlock64 m_tweak; }; -/// \class Threefish256 /// \brief Threefish 256-bit block cipher /// \details Threefish256 provides 256-bit block size. The valid key size is 256-bit. /// \note Crypto++ provides a byte oriented implementation @@ -111,7 +108,6 @@ public: typedef Threefish256::Encryption Threefish256Encryption; typedef Threefish256::Decryption Threefish256Decryption; -/// \class Threefish512 /// \brief Threefish 512-bit block cipher /// \details Threefish512 provides 512-bit block size. The valid key size is 512-bit. /// \note Crypto++ provides a byte oriented implementation @@ -156,7 +152,6 @@ public: typedef Threefish512::Encryption Threefish512Encryption; typedef Threefish512::Decryption Threefish512Decryption; -/// \class Threefish1024 /// \brief Threefish 1024-bit block cipher /// \details Threefish1024 provides 1024-bit block size. The valid key size is 1024-bit. /// \note Crypto++ provides a byte oriented implementation diff --git a/ttmac.h b/ttmac.h index d0943c80..3433ded6 100644 --- a/ttmac.h +++ b/ttmac.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class TTMAC_Base /// \brief TTMAC message authentication code information class CRYPTOPP_NO_VTABLE TTMAC_Base : public FixedKeyLength<20>, public IteratedHash { @@ -34,7 +33,6 @@ protected: FixedSizeSecBlock m_key; }; -/// \class TTMAC /// \brief Two-Track-MAC message authentication code /// \tparam T HashTransformation class /// \details 160-bit MAC with 160-bit key diff --git a/twofish.h b/twofish.h index 7dcf74a6..84b2bb53 100644 --- a/twofish.h +++ b/twofish.h @@ -11,14 +11,12 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class Twofish_Info /// \brief Twofish block cipher information struct Twofish_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 8>, FixedRounds<16> { CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "Twofish";} }; -/// \class Twofish /// \brief Twofish block cipher //~ \sa Twofish class Twofish : public Twofish_Info, public BlockCipherDocumentation diff --git a/vmac.h b/vmac.h index 3e61bc43..18d06efe 100644 --- a/vmac.h +++ b/vmac.h @@ -19,7 +19,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class VMAC_Base /// \brief VMAC message authentication code base class /// \since Crypto++ 5.5 class VMAC_Base : public IteratedHashBase @@ -64,7 +63,6 @@ protected: unsigned int m_L1KeyLength; }; -/// \class VMAC /// \brief VMAC message authentication code /// \tparam T_BlockCipher block cipher /// \tparam T_DigestBitSize digest size, in bits diff --git a/wake.h b/wake.h index 8f1269e7..e2a6456b 100644 --- a/wake.h +++ b/wake.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class WAKE_OFB_Info /// \brief WAKE stream cipher information /// \tparam B Endianness of the stream cipher /// \since Crypto++ 1.0 @@ -32,7 +31,6 @@ protected: word32 r3, r4, r5, r6; }; -/// \class WAKE_Policy /// \brief WAKE stream cipher operation /// \tparam B Endianness of the stream cipher /// \since Crypto++ 1.0 @@ -46,7 +44,6 @@ protected: bool CipherIsRandomAccess() const {return false;} }; -/// \class WAKE_OFB /// \brief WAKE stream cipher /// \tparam B Endianness of the stream cipher /// \since Crypto++ 1.0 diff --git a/xtr.h b/xtr.h index 396c11e6..29479d8c 100644 --- a/xtr.h +++ b/xtr.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class GFP2Element /// \brief an element of GF(p^2) class GFP2Element { @@ -42,7 +41,6 @@ public: Integer c1, c2; }; -/// \class GFP2_ONB /// \brief GF(p^2), optimal normal basis template class GFP2_ONB : public AbstractRing diff --git a/zdeflate.h b/zdeflate.h index 8b1d5cb6..b9f61e82 100644 --- a/zdeflate.h +++ b/zdeflate.h @@ -12,7 +12,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class LowFirstBitWriter /// \brief Encoding table writer /// \since Crypto++ 1.0 class LowFirstBitWriter : public Filter @@ -37,7 +36,6 @@ protected: FixedSizeSecBlock m_outputBuffer; }; -/// \class HuffmanEncoder /// \brief Huffman Encoder /// \since Crypto++ 1.0 class HuffmanEncoder @@ -72,7 +70,6 @@ public: SecBlock m_valueToCode; }; -/// \class Deflator /// \brief DEFLATE compressor (RFC 1951) /// \since Crypto++ 1.0 class Deflator : public LowFirstBitWriter diff --git a/zinflate.h b/zinflate.h index 035b095e..e352aff7 100644 --- a/zinflate.h +++ b/zinflate.h @@ -8,7 +8,6 @@ NAMESPACE_BEGIN(CryptoPP) -/// \class LowFirstBitReader /// \since Crypto++ 1.0 class LowFirstBitReader { @@ -30,7 +29,6 @@ private: struct CodeLessThan; -/// \class HuffmanDecoder /// \brief Huffman Decoder /// \since Crypto++ 1.0 class HuffmanDecoder @@ -86,7 +84,6 @@ private: mutable std::vector > m_cache; }; -/// \class Inflator /// \brief DEFLATE decompressor (RFC 1951) /// \since Crypto++ 1.0 class Inflator : public AutoSignaling