From efd4bc6b08cf70407224d3234c570524180f9f46 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Tue, 25 Oct 2016 23:43:40 -0400 Subject: [PATCH] Updated documentation --- dmac.h | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/dmac.h b/dmac.h index 59713511..b797a12d 100644 --- a/dmac.h +++ b/dmac.h @@ -11,7 +11,9 @@ NAMESPACE_BEGIN(CryptoPP) -//! _ +//! \class DMAC_Base +//! \brief DMAC message authentication code base class +//! \tparam T class derived from BlockCipherDocumentation template class CRYPTOPP_NO_VTABLE DMAC_Base : public SameKeyLengthAs, public MessageAuthenticationCode { @@ -37,15 +39,21 @@ private: unsigned int m_counter; }; -//! DMAC -/*! Based on "CBC MAC for Real-Time Data Sources" by Erez Petrank - and Charles Rackoff. T should be a class derived from BlockCipherDocumentation. -*/ +//! \class DMAC +//! \brief DMAC message authentication code +//! \tparam T class derived from BlockCipherDocumentation +//! \sa CBC MAC for Real-Time Data Sources (08.15.1997) +//! by Erez Petrank and Charles Rackoff template class DMAC : public MessageAuthenticationCodeFinal > { public: + //! \brief Construct a DMAC DMAC() {} + + //! \brief Construct a DMAC + //! \param key a byte array used to key the cipher + //! \param length the size of the byte array, in bytes DMAC(const byte *key, size_t length=DMAC_Base::DEFAULT_KEYLENGTH) {this->SetKey(key, length);} };