diff options
author | Jeffrey Walton <noloader@gmail.com> | 2018-02-13 04:41:51 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2018-02-13 04:41:51 -0500 |
commit | e8c538cae6457896e3d8b31b41459559018b3ff9 (patch) | |
tree | dbe41920f06bd3c4d5f2d1b58cbb6475704ddba8 /whrlpool.h | |
parent | ac4c87a1b830f71c2452b066d972ad66a7267770 (diff) | |
download | cryptopp-git-e8c538cae6457896e3d8b31b41459559018b3ff9.tar.gz |
Updated documentation
Diffstat (limited to 'whrlpool.h')
-rw-r--r-- | whrlpool.h | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -1,12 +1,25 @@ +// whrlpool.h - originally modified by Kevin Springle from Paulo Barreto and Vincent Rijmen's
+// public domain code, whirlpool.c. Updated to Whirlpool version 3.0, optimized
+// and SSE version added by WD. All modifications are placed in the public domain.
+
#ifndef CRYPTOPP_WHIRLPOOL_H
#define CRYPTOPP_WHIRLPOOL_H
+/// \file whrlpool.h
+/// \brief Classes for the Whirlpool message digest
+/// \details Crypto++ provides version 3.0 of the Whirlpool algorithm.
+/// This version of the algorithm was submitted for ISO standardization.
+
#include "config.h"
#include "iterhash.h"
NAMESPACE_BEGIN(CryptoPP)
-/// <a href="http://www.cryptolounge.org/wiki/Whirlpool">Whirlpool</a>
+/// \brief Whirlpool message digest
+/// \details Crypto++ provides version 3.0 of the Whirlpool algorithm.
+/// This version of the algorithm was submitted for ISO standardization.
+/// \since Crypto++ 5.2
+/// \sa <a href="http://www.cryptopp.com/wiki/Whirlpool">Whirlpool</a>
class Whirlpool : public IteratedHashWithStaticTransform<word64, BigEndian, 64, 64, Whirlpool>
{
public:
|