From 61ec50dabe14c5d4582ac187706ea27645b3562b Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Wed, 29 Nov 2017 10:54:33 -0500 Subject: Change Doxygen comment style from //! to /// Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw --- chacha.h | 62 +++++++++++++++++++++++++++++++------------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) (limited to 'chacha.h') diff --git a/chacha.h b/chacha.h index b07031b7..12547380 100644 --- a/chacha.h +++ b/chacha.h @@ -2,13 +2,13 @@ // Based on Wei Dai's Salsa20 and Bernstein's reference ChaCha // family implementation at http://cr.yp.to/chacha.html. -//! \file chacha.h -//! \brief Classes for ChaCha8, ChaCha12 and ChaCha20 stream ciphers -//! \details Crypto++ provides Bernstein and ECRYPT's ChaCha from ChaCha, -//! a variant of Salsa20 (2008.01.28). Bernstein's implementation is _slightly_ different from the TLS working group's -//! implementation for cipher suites TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, -//! TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, and TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256. -//! \since Crypto++ 5.6.4 +/// \file chacha.h +/// \brief Classes for ChaCha8, ChaCha12 and ChaCha20 stream ciphers +/// \details Crypto++ provides Bernstein and ECRYPT's ChaCha from ChaCha, +/// a variant of Salsa20 (2008.01.28). Bernstein's implementation is _slightly_ different from the TLS working group's +/// implementation for cipher suites TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, +/// TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, and TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256. +/// \since Crypto++ 5.6.4 #ifndef CRYPTOPP_CHACHA_H #define CRYPTOPP_CHACHA_H @@ -18,9 +18,9 @@ NAMESPACE_BEGIN(CryptoPP) -//! \class ChaCha_Info -//! \brief ChaCha stream cipher information -//! \since Crypto++ 5.6.4 +/// \class ChaCha_Info +/// \brief ChaCha stream cipher information +/// \since Crypto++ 5.6.4 template struct ChaCha_Info : public VariableKeyLength<32, 16, 32, 16, SimpleKeyingInterface::UNIQUE_IV, 8>, public FixedRounds { @@ -29,9 +29,9 @@ struct ChaCha_Info : public VariableKeyLength<32, 16, 32, 16, SimpleKeyingInterf } }; -//! \class ChaCha_Policy -//! \brief ChaCha stream cipher implementation -//! \since Crypto++ 5.6.4 +/// \class ChaCha_Policy +/// \brief ChaCha stream cipher implementation +/// \since Crypto++ 5.6.4 template class CRYPTOPP_NO_VTABLE ChaCha_Policy : public AdditiveCipherConcretePolicy { @@ -49,36 +49,36 @@ protected: FixedSizeAlignedSecBlock m_state; }; -//! \class ChaCha8 -//! \brief ChaCha8 stream cipher -//! \sa ChaCha, a variant of Salsa20 (2008.01.28). -//! \since Crypto++ 5.6.4 +/// \class ChaCha8 +/// \brief ChaCha8 stream cipher +/// \sa ChaCha, a variant of Salsa20 (2008.01.28). +/// \since Crypto++ 5.6.4 struct ChaCha8 : public ChaCha_Info<8>, public SymmetricCipherDocumentation { typedef SymmetricCipherFinal, AdditiveCipherTemplate<> >, ChaCha_Info<8> > Encryption; typedef Encryption Decryption; }; -//! \class ChaCha12 -//! \brief ChaCha12 stream cipher -//! \details Bernstein and ECRYPT's ChaCha is _slightly_ different from the TLS working group's implementation for -//! cipher suites TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, -//! TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, and TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256. -//! \sa ChaCha, a variant of Salsa20 (2008.01.28). -//! \since Crypto++ 5.6.4 +/// \class ChaCha12 +/// \brief ChaCha12 stream cipher +/// \details Bernstein and ECRYPT's ChaCha is _slightly_ different from the TLS working group's implementation for +/// cipher suites TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, +/// TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, and TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256. +/// \sa ChaCha, a variant of Salsa20 (2008.01.28). +/// \since Crypto++ 5.6.4 struct ChaCha12 : public ChaCha_Info<12>, public SymmetricCipherDocumentation { typedef SymmetricCipherFinal, AdditiveCipherTemplate<> >, ChaCha_Info<12> > Encryption; typedef Encryption Decryption; }; -//! \class ChaCha20 -//! \brief ChaCha20 stream cipher -//! \sa ChaCha, a variant of Salsa20 (2008.01.28). -//! \details Bernstein and ECRYPT's ChaCha is _slightly_ different from the TLS working group's implementation for -//! cipher suites TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, -//! TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, and TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256. -//! \since Crypto++ 5.6.4 +/// \class ChaCha20 +/// \brief ChaCha20 stream cipher +/// \sa ChaCha, a variant of Salsa20 (2008.01.28). +/// \details Bernstein and ECRYPT's ChaCha is _slightly_ different from the TLS working group's implementation for +/// cipher suites TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, +/// TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, and TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256. +/// \since Crypto++ 5.6.4 struct ChaCha20 : public ChaCha_Info<20>, public SymmetricCipherDocumentation { typedef SymmetricCipherFinal, AdditiveCipherTemplate<> >, ChaCha_Info<20> > Encryption; -- cgit v1.2.1