arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

pull/687/head
Jeffrey Walton 2018-07-13 09:54:06 -04:00
parent 678bdb1735
commit 380829284c
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
10 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cham.h
View File

@ -67,7 +67,7 @@ public:
unsigned int m_kw; unsigned int m_kw;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block /// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
@ -81,7 +81,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block /// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
@ -126,7 +126,7 @@ public:
unsigned int m_kw; unsigned int m_kw;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block /// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
@ -140,7 +140,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block /// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1

4
hight.h
View File

@ -51,7 +51,7 @@ public:
mutable FixedSizeSecBlock<word32, 8> m_xx; mutable FixedSizeSecBlock<word32, 8> m_xx;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. /// \details Enc provides implementation for encryption transformation.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
class CRYPTOPP_NO_VTABLE Enc : public Base class CRYPTOPP_NO_VTABLE Enc : public Base
@ -60,7 +60,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. /// \details Dec provides implementation for decryption transformation.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
class CRYPTOPP_NO_VTABLE Dec : public Base class CRYPTOPP_NO_VTABLE Dec : public Base

4
lea.h
View File

@ -56,7 +56,7 @@ public:
unsigned int m_rounds; unsigned int m_rounds;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block /// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
@ -70,7 +70,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block /// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1

4
rijndael.h
View File

@ -62,7 +62,7 @@ class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentat
mutable SecByteBlock m_aliasBlock; mutable SecByteBlock m_aliasBlock;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key sizes are supported. /// \details Enc provides implementation for encryption transformation. All key sizes are supported.
/// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks /// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
/// \since Rijndael since Crypto++ 3.1, Intel AES-NI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0, /// \since Rijndael since Crypto++ 3.1, Intel AES-NI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
@ -76,7 +76,7 @@ class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentat
#endif #endif
}; };
/// \brief Provides implementation for decryption transformation /// \brief Decryption transformation
/// \details Dec provides implementation for decryption transformation. All key sizes are supported. /// \details Dec provides implementation for decryption transformation. All key sizes are supported.
/// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks /// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
/// \since Rijndael since Crypto++ 3.1, Intel AES-NI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0, /// \since Rijndael since Crypto++ 3.1, Intel AES-NI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,

4
shacal2.h
View File

@ -37,7 +37,7 @@ class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation
}; };
/// \brief SHACAL2 block cipher transformation functions /// \brief SHACAL2 block cipher transformation functions
/// \details Provides implementation for encryption transformation /// \details Encryption transformation
class CRYPTOPP_NO_VTABLE Enc : public Base class CRYPTOPP_NO_VTABLE Enc : public Base
{ {
public: public:
@ -45,7 +45,7 @@ class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation
}; };
/// \brief SHACAL2 block cipher transformation functions /// \brief SHACAL2 block cipher transformation functions
/// \details Provides implementation for decryption transformation /// \details Decryption transformation
class CRYPTOPP_NO_VTABLE Dec : public Base class CRYPTOPP_NO_VTABLE Dec : public Base
{ {
public: public:

8
simeck.h
View File

@ -68,7 +68,7 @@ public:
mutable FixedSizeSecBlock<word16, 5> m_t; mutable FixedSizeSecBlock<word16, 5> m_t;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block /// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
@ -78,7 +78,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block /// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
@ -118,7 +118,7 @@ public:
mutable FixedSizeSecBlock<word32, 5> m_t; mutable FixedSizeSecBlock<word32, 5> m_t;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block /// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1
@ -132,7 +132,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block /// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 7.1 /// \since Crypto++ 7.1

8
simon.h
View File

@ -90,7 +90,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params); void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key /// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -103,7 +103,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key /// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -149,7 +149,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params); void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key /// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -162,7 +162,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key /// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0

4
sm4.h
View File

@ -54,7 +54,7 @@ public:
mutable SecBlock<word32, AllocatorWithCleanup<word32> > m_wspace; mutable SecBlock<word32, AllocatorWithCleanup<word32> > m_wspace;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key /// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \details SM4 encryption is accelerated on machines with AES-NI. Decryption is /// \details SM4 encryption is accelerated on machines with AES-NI. Decryption is
@ -72,7 +72,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key /// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \details SM4 encryption is accelerated on machines with AES-NI. Decryption is /// \details SM4 encryption is accelerated on machines with AES-NI. Decryption is

8
speck.h
View File

@ -90,7 +90,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params); void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key /// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -103,7 +103,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key /// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -149,7 +149,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params); void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key /// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -162,7 +162,7 @@ public:
#endif #endif
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key /// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0

12
threefish.h
View File

@ -81,7 +81,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params); void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block /// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -91,7 +91,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block /// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -125,7 +125,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params); void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block /// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -135,7 +135,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block /// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -169,7 +169,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params); void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block /// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
@ -179,7 +179,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
}; };
/// \brief Provides implementation for encryption transformation /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block /// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported. /// sizes are supported.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0