From 8c29b1a4d3f6a382038617c7ce68e7a3316f85e8 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Fri, 24 Nov 2017 00:06:48 -0500 Subject: Update documentation --- sm3.h | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) (limited to 'sm3.h') diff --git a/sm3.h b/sm3.h index 9a21f88a..c9d093cf 100644 --- a/sm3.h +++ b/sm3.h @@ -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 data. When the call is invoked - //! digest holds initial state. Upon return digest holds the hash - //! or updated state. + //! \details Transform() operates the hash on data. When the call is invoked + //! digest holds initial or current state. Upon return digest 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 -- cgit v1.2.1