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 --- cmac.h | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'cmac.h') diff --git a/cmac.h b/cmac.h index 60482277..29dfb097 100644 --- a/cmac.h +++ b/cmac.h @@ -1,8 +1,8 @@ // cmac.h - originally written and placed in the public domain by Wei Dai -//! \file cmac.h -//! \brief Classes for CMAC message authentication code -//! \since Crypto++ 5.6.0 +/// \file cmac.h +/// \brief Classes for CMAC message authentication code +/// \since Crypto++ 5.6.0 #ifndef CRYPTOPP_CMAC_H #define CRYPTOPP_CMAC_H @@ -12,9 +12,9 @@ NAMESPACE_BEGIN(CryptoPP) -//! \class CMAC_Base -//! \brief CMAC base implementation -//! \since Crypto++ 5.6.0 +/// \class CMAC_Base +/// \brief CMAC base implementation +/// \since Crypto++ 5.6.0 class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CMAC_Base : public MessageAuthenticationCode { public: @@ -38,20 +38,20 @@ protected: unsigned int m_counter; }; -//! \brief CMAC message authentication code -//! \tparam T block cipher -//! \details Template parameter T should be a class derived from BlockCipherDocumentation, for example AES, with a block size of 8, 16, or 32. -//! \sa CMAC -//! \since Crypto++ 5.6.0 +/// \brief CMAC message authentication code +/// \tparam T block cipher +/// \details Template parameter T should be a class derived from BlockCipherDocumentation, for example AES, with a block size of 8, 16, or 32. +/// \sa CMAC +/// \since Crypto++ 5.6.0 template class CMAC : public MessageAuthenticationCodeImpl >, public SameKeyLengthAs { public: - //! \brief Construct a CMAC + /// \brief Construct a CMAC CMAC() {} - //! \brief Construct a CMAC - //! \param key the MAC key - //! \param length the key size, in bytes + /// \brief Construct a CMAC + /// \param key the MAC key + /// \param length the key size, in bytes CMAC(const byte *key, size_t length=SameKeyLengthAs::DEFAULT_KEYLENGTH) {this->SetKey(key, length);} -- cgit v1.2.1