From 4c78330cb9e92a0580f9811190d39ccb44f7779d Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Thu, 21 Apr 2016 00:24:55 -0400 Subject: [PATCH] Updated documentation --- cmac.h | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/cmac.h b/cmac.h index dfbdbffe..b43ce132 100644 --- a/cmac.h +++ b/cmac.h @@ -1,7 +1,6 @@ // cmac.h - written and placed in the public domain by Wei Dai -//! \file -//! \headerfile cmac.h +//! \file cmac.h //! \brief Classes for CMAC message authentication code #ifndef CRYPTOPP_CMAC_H @@ -12,7 +11,8 @@ NAMESPACE_BEGIN(CryptoPP) -//! _ +//! \class CMAC_Base +//! \brief CMAC base implementation class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE CMAC_Base : public MessageAuthenticationCode { public: @@ -36,13 +36,19 @@ protected: unsigned int m_counter; }; -/// CMAC -/*! Template parameter T should be a class derived from BlockCipherDocumentation, for example AES, with a block size of 8, 16, or 32 */ +//! \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 template class CMAC : public MessageAuthenticationCodeImpl >, public SameKeyLengthAs { public: + //! \brief Construct a CMAC CMAC() {} + //! \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);}