Updated documentation

1 files 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;

 };

 

-/// <a href="http://www.cryptolounge.org/wiki/CMAC">CMAC</a>

-/*! 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 <a href="http://www.cryptolounge.org/wiki/CMAC">CMAC</a>

 template <class T>

 class CMAC : public MessageAuthenticationCodeImpl<CMAC_Base, CMAC<T> >, public SameKeyLengthAs<T>

 {

 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<T>::DEFAULT_KEYLENGTH)

 		{this->SetKey(key, length);}