diff options
author | Jeffrey Walton <noloader@gmail.com> | 2017-11-24 00:06:48 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2017-11-24 00:06:48 -0500 |
commit | 8c29b1a4d3f6a382038617c7ce68e7a3316f85e8 (patch) | |
tree | 29161b19ce2e8955c09073e3169b86ea6570b0a1 /sm3.h | |
parent | 5267723a4923464f677d22f73f97a9e975a187a9 (diff) | |
download | cryptopp-git-8c29b1a4d3f6a382038617c7ce68e7a3316f85e8.tar.gz |
Update documentation
Diffstat (limited to 'sm3.h')
-rw-r--r-- | sm3.h | 12 |
1 files changed, 5 insertions, 7 deletions
@@ -29,23 +29,21 @@ public: //! \param state the state of the hash
//! \details InitState sets a state array to SHA256 initial values
//! \details Hashes which derive from IteratedHashWithStaticTransform provide static
- //! member functions InitState and Transform. External classes, like SEAL and MDC,
+ //! member functions InitState() and Transform(). External classes, like SEAL and MDC,
//! can initialize state with a user provided key and operate the hash on the data
//! with the user supplied state.
- //! \note On Intel platforms the state array must be 16-byte aligned for SSE2.
static void InitState(HashWordType *state);
//! \brief Operate the hash
//! \param digest the state of the hash
//! \param data the data to be digested
- //! \details Transform operates the hash on <tt>data</tt>. When the call is invoked
- //! <tt>digest</tt> holds initial state. Upon return <tt>digest</tt> holds the hash
- //! or updated state.
+ //! \details Transform() operates the hash on <tt>data</tt>. When the call is invoked
+ //! <tt>digest</tt> holds initial or current state. Upon return <tt>digest</tt> holds
+ //! the hash or updated state.
//! \details Hashes which derive from IteratedHashWithStaticTransform provide static
- //! member functions InitState and Transform. External classes, like SEAL and MDC,
+ //! member functions InitState() and Transform(). External classes, like SEAL and MDC,
//! can initialize state with a user provided key and operate the hash on the data
//! with the user supplied state.
- //! \note On Intel platforms the state array and data must be 16-byte aligned for SSE2.
static void Transform(HashWordType *digest, const HashWordType *data);
//! \brief The algorithm name
|