Update documentation

pull/748/head
Jeffrey Walton 2018-11-15 04:39:54 -05:00
parent 8b4da4ca68
commit 98699dde05
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
2 changed files with 6 additions and 4 deletions

View File

@ -361,6 +361,7 @@ public:
/// \brief Construct a CipherModeFinalTemplate
/// \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
/// SimpleKeyingInterface::SetKey.
CipherModeFinalTemplate_CipherHolder(const byte *key, size_t length)
@ -371,6 +372,7 @@ public:
/// \brief Construct a CipherModeFinalTemplate
/// \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
/// \details key must be at least DEFAULT_KEYLENGTH in length. iv must be IVSize() or
/// BLOCKSIZE in length. Internally, the function calls SimpleKeyingInterface::SetKey.
@ -382,6 +384,7 @@ public:
/// \brief Construct a CipherModeFinalTemplate
/// \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 feedbackSize the feedback size, in bytes
/// \details key must be at least DEFAULT_KEYLENGTH in length. iv must be IVSize() or

View File

@ -29,8 +29,8 @@
# undef bool
#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
# pragma GCC diagnostic push
# 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
/// \param src the byte array
/// \param off offset into the byte array
/// \details Loads a vector in native endian format from a byte array.
/// \note VectorLoad does not require an aligned array.
/// \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
/// \tparam T vector type
/// \param data the vector
/// \param off the byte offset into the array
/// \param dest the byte array
/// \details Stores a vector in native endian format to a byte 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
/// \tparam T vector type
/// \param data the vector
/// \param off the byte offset into the array
/// \param dest the byte array
/// \details Stores a vector in native endian format to a byte array.
/// \note VectorStore does not require an aligned array.