From d55d3d53d12ec324bf1562a0a4563cb82cc19a9a Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Tue, 1 Nov 2016 21:06:52 -0400 Subject: [PATCH] Updated documentation --- sosemanuk.h | 18 +++++++++++++++--- vmac.h | 3 +++ 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/sosemanuk.h b/sosemanuk.h index a64d92c2..972e6935 100644 --- a/sosemanuk.h +++ b/sosemanuk.h @@ -2,6 +2,7 @@ //! \file sosemanuk.h //! \brief Classes for Sosemanuk stream cipher +//! \since Crypto++ 5.5 #ifndef CRYPTOPP_SOSEMANUK_H #define CRYPTOPP_SOSEMANUK_H @@ -17,13 +18,17 @@ NAMESPACE_BEGIN(CryptoPP) -//! algorithm info +//! \class SosemanukInfo +//! \brief Sosemanuk stream cipher information + //! \since Crypto++ 5.5 struct SosemanukInfo : public VariableKeyLength<16, 1, 32, 1, SimpleKeyingInterface::UNIQUE_IV, 16> { CRYPTOPP_CONSTEXPR static const char *StaticAlgorithmName() {return "Sosemanuk";} }; -//! _ +//! \class SosemanukPolicy +//! \brief Sosemanuk stream cipher implementation +//! \since Crypto++ 5.5 class SosemanukPolicy : public AdditiveCipherConcretePolicy, public SosemanukInfo { protected: @@ -40,7 +45,14 @@ protected: FixedSizeAlignedSecBlock m_state; }; -//! Sosemanuk +//! \class Sosemanuk +//! \brief Sosemanuk stream cipher +//! \details is a stream cipher developed by Come Berbain, Olivier Billet, Anne Canteaut, Nicolas Courtois, +//! Henri Gilbert, Louis Goubin, Aline Gouget, Louis Granboulan, Cédric Lauradoux, Marine Minier, Thomas +//! Pornin and Hervé Sibert. Sosemanuk is one of the final four Profile 1 (software) ciphers selected for +//! the eSTREAM Portfolio. +//! \sa Sosemanuk +//! \since Crypto++ 5.5 struct Sosemanuk : public SosemanukInfo, public SymmetricCipherDocumentation { typedef SymmetricCipherFinal >, SosemanukInfo> Encryption; diff --git a/vmac.h b/vmac.h index 3c6bb858..e2d15d11 100644 --- a/vmac.h +++ b/vmac.h @@ -2,6 +2,7 @@ //! \file vmac.h //! \brief Classes for the VMAC message authentication code +//! \since Crypto++ 5.5 #ifndef CRYPTOPP_VMAC_H #define CRYPTOPP_VMAC_H @@ -20,6 +21,7 @@ NAMESPACE_BEGIN(CryptoPP) //! \class VMAC_Base //! \brief VMAC message authentication code base class +//! \since Crypto++ 5.5 class VMAC_Base : public IteratedHashBase { public: @@ -74,6 +76,7 @@ protected: //! \details The implementation is based on Ted Krovetz's public domain vmac.c //! and draft-krovetz-vmac-01.txt. //! \sa VMAC. +//! \since Crypto++ 5.5 template class VMAC : public SimpleKeyingInterfaceImpl > {