Update documentation
parent
8b4da4ca68
commit
98699dde05
3
modes.h
3
modes.h
|
|
@ -361,6 +361,7 @@ public:
|
||||||
|
|
||||||
/// \brief Construct a CipherModeFinalTemplate
|
/// \brief Construct a CipherModeFinalTemplate
|
||||||
/// \param key a byte array used to key the cipher
|
/// \param key a byte array used to key the cipher
|
||||||
|
/// \param length size of the key in bytes
|
||||||
/// \details key must be at least DEFAULT_KEYLENGTH in length. Internally, the function calls
|
/// \details key must be at least DEFAULT_KEYLENGTH in length. Internally, the function calls
|
||||||
/// SimpleKeyingInterface::SetKey.
|
/// SimpleKeyingInterface::SetKey.
|
||||||
CipherModeFinalTemplate_CipherHolder(const byte *key, size_t length)
|
CipherModeFinalTemplate_CipherHolder(const byte *key, size_t length)
|
||||||
|
|
@ -371,6 +372,7 @@ public:
|
||||||
|
|
||||||
/// \brief Construct a CipherModeFinalTemplate
|
/// \brief Construct a CipherModeFinalTemplate
|
||||||
/// \param key a byte array used to key the cipher
|
/// \param key a byte array used to key the cipher
|
||||||
|
/// \param length size of the key in bytes
|
||||||
/// \param iv a byte array used to resynchronize the cipher
|
/// \param iv a byte array used to resynchronize the cipher
|
||||||
/// \details key must be at least DEFAULT_KEYLENGTH in length. iv must be IVSize() or
|
/// \details key must be at least DEFAULT_KEYLENGTH in length. iv must be IVSize() or
|
||||||
/// BLOCKSIZE in length. Internally, the function calls SimpleKeyingInterface::SetKey.
|
/// BLOCKSIZE in length. Internally, the function calls SimpleKeyingInterface::SetKey.
|
||||||
|
|
@ -382,6 +384,7 @@ public:
|
||||||
|
|
||||||
/// \brief Construct a CipherModeFinalTemplate
|
/// \brief Construct a CipherModeFinalTemplate
|
||||||
/// \param key a byte array used to key the cipher
|
/// \param key a byte array used to key the cipher
|
||||||
|
/// \param length size of the key in bytes
|
||||||
/// \param iv a byte array used to resynchronize the cipher
|
/// \param iv a byte array used to resynchronize the cipher
|
||||||
/// \param feedbackSize the feedback size, in bytes
|
/// \param feedbackSize the feedback size, in bytes
|
||||||
/// \details key must be at least DEFAULT_KEYLENGTH in length. iv must be IVSize() or
|
/// \details key must be at least DEFAULT_KEYLENGTH in length. iv must be IVSize() or
|
||||||
|
|
|
||||||
|
|
@ -29,8 +29,8 @@
|
||||||
# undef bool
|
# undef bool
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// VectorLoad_ALTIVEC and VectorStore_ALTIVEC are too noisy on modern compilers
|
// VectorLoad_ALTIVEC and VectorStore_ALTIVEC are
|
||||||
|
// too noisy on modern compilers
|
||||||
#if CRYPTOPP_GCC_DIAGNOSTIC_AVAILABLE
|
#if CRYPTOPP_GCC_DIAGNOSTIC_AVAILABLE
|
||||||
# pragma GCC diagnostic push
|
# pragma GCC diagnostic push
|
||||||
# pragma GCC diagnostic ignored "-Wdeprecated"
|
# pragma GCC diagnostic ignored "-Wdeprecated"
|
||||||
|
|
@ -146,7 +146,6 @@ inline uint32x4_p VectorLoad(int off, const byte src[16])
|
||||||
|
|
||||||
/// \brief Loads a vector from a byte array
|
/// \brief Loads a vector from a byte array
|
||||||
/// \param src the byte array
|
/// \param src the byte array
|
||||||
/// \param off offset into the byte array
|
|
||||||
/// \details Loads a vector in native endian format from a byte array.
|
/// \details Loads a vector in native endian format from a byte array.
|
||||||
/// \note VectorLoad does not require an aligned array.
|
/// \note VectorLoad does not require an aligned array.
|
||||||
/// \since Crypto++ 6.0
|
/// \since Crypto++ 6.0
|
||||||
|
|
@ -313,7 +312,6 @@ inline void VectorStore(const T data, int off, byte dest[16])
|
||||||
/// \brief Stores a vector to a word array
|
/// \brief Stores a vector to a word array
|
||||||
/// \tparam T vector type
|
/// \tparam T vector type
|
||||||
/// \param data the vector
|
/// \param data the vector
|
||||||
/// \param off the byte offset into the array
|
|
||||||
/// \param dest the byte array
|
/// \param dest the byte array
|
||||||
/// \details Stores a vector in native endian format to a byte array.
|
/// \details Stores a vector in native endian format to a byte array.
|
||||||
/// \note VectorStore does not require an aligned array.
|
/// \note VectorStore does not require an aligned array.
|
||||||
|
|
@ -327,6 +325,7 @@ inline void VectorStore(const T data, word32 dest[4])
|
||||||
/// \brief Stores a vector to a word array
|
/// \brief Stores a vector to a word array
|
||||||
/// \tparam T vector type
|
/// \tparam T vector type
|
||||||
/// \param data the vector
|
/// \param data the vector
|
||||||
|
/// \param off the byte offset into the array
|
||||||
/// \param dest the byte array
|
/// \param dest the byte array
|
||||||
/// \details Stores a vector in native endian format to a byte array.
|
/// \details Stores a vector in native endian format to a byte array.
|
||||||
/// \note VectorStore does not require an aligned array.
|
/// \note VectorStore does not require an aligned array.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue