Updated documentation

pull/586/head
Jeffrey Walton 2018-02-13 04:41:51 -05:00
parent ac4c87a1b8
commit e8c538cae6
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
2 changed files with 18 additions and 6 deletions

View File

@ -1,8 +1,7 @@
// whrlpool.cpp - originally modified by Kevin Springle from // whrlpool.cpp - originally modified by Kevin Springle from Paulo Barreto and Vincent Rijmen's
// Paulo Barreto and Vincent Rijmen's public domain code, whirlpool.c. // public domain code, whirlpool.c. Updated to Whirlpool version 3.0, optimized
// Updated to Whirlpool version 3.0, optimized and SSE version added by Wei Dai // and SSE version added by WD. All modifications are placed in the public domain.
// All modifications are placed in the public domain //
// This is the original introductory comment: // This is the original introductory comment:
/** /**

View File

@ -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 #ifndef CRYPTOPP_WHIRLPOOL_H
#define 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 "config.h"
#include "iterhash.h" #include "iterhash.h"
NAMESPACE_BEGIN(CryptoPP) 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> class Whirlpool : public IteratedHashWithStaticTransform<word64, BigEndian, 64, 64, Whirlpool>
{ {
public: public: