From 8ac5c499c2e07792105b51b9288be3e9beba3031 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Thu, 21 Apr 2016 00:40:03 -0400 Subject: Updated documentation --- salsa.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'salsa.h') diff --git a/salsa.h b/salsa.h index 5c2c91c5..37742400 100644 --- a/salsa.h +++ b/salsa.h @@ -19,7 +19,7 @@ NAMESPACE_BEGIN(CryptoPP) //! \class Salsa20_Info -//! \brief Salsa block cipher information +//! \brief Salsa stream cipher information struct Salsa20_Info : public VariableKeyLength<32, 16, 32, 16, SimpleKeyingInterface::UNIQUE_IV, 8> { static const char *StaticAlgorithmName() {return "Salsa20";} @@ -42,10 +42,10 @@ protected: int m_rounds; }; -// Salsa20, variable rounds: 8, 12 or 20 (default 20) //! \class Salsa20 -//! \brief Salsa20 block cipher information -//! \details Salsa20 provides a variable number of rounds: 8, 12 or 20. The default number of rounds is 20. +//! \brief Salsa20 stream cipher information +//! \details XSalsa20 provides a variable number of rounds: 8, 12 or 20. The default number of rounds is 20. +//! \sa XSalsa20 struct Salsa20 : public Salsa20_Info, public SymmetricCipherDocumentation { typedef SymmetricCipherFinal >, Salsa20_Info> Encryption; @@ -53,7 +53,7 @@ struct Salsa20 : public Salsa20_Info, public SymmetricCipherDocumentation }; //! \class XSalsa20_Info -//! \brief XSalsa20 block cipher information +//! \brief XSalsa20 stream cipher information struct XSalsa20_Info : public FixedKeyLength<32, SimpleKeyingInterface::UNIQUE_IV, 24> { static const char *StaticAlgorithmName() {return "XSalsa20";} @@ -69,10 +69,10 @@ protected: FixedSizeSecBlock m_key; }; -// XSalsa20, variable rounds: 8, 12 or 20 (default 20) //! \class XSalsa20 -//! \brief XSalsa20 block cipher information +//! \brief XSalsa20 stream cipher information //! \details XSalsa20 provides a variable number of rounds: 8, 12 or 20. The default number of rounds is 20. +//! \sa XSalsa20 struct XSalsa20 : public XSalsa20_Info, public SymmetricCipherDocumentation { typedef SymmetricCipherFinal >, XSalsa20_Info> Encryption; -- cgit v1.2.1