diff options
author | Jeffrey Walton <noloader@gmail.com> | 2017-11-29 10:54:33 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2017-11-29 10:54:33 -0500 |
commit | 61ec50dabe14c5d4582ac187706ea27645b3562b (patch) | |
tree | 18a2eebb7adc8c9556ce132d7081a105fa058d6b /vmac.h | |
parent | 16ebfa72bf130c4725e652e4d3688d97d3feb0ee (diff) | |
download | cryptopp-git-61ec50dabe14c5d4582ac187706ea27645b3562b.tar.gz |
Change Doxygen comment style from //! to ///
Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw
Diffstat (limited to 'vmac.h')
-rw-r--r-- | vmac.h | 34 |
1 files changed, 17 insertions, 17 deletions
@@ -1,8 +1,8 @@ // vmac.h - originally written and placed in the public domain by Wei Dai
-//! \file vmac.h
-//! \brief Classes for the VMAC message authentication code
-//! \since Crypto++ 5.5
+/// \file vmac.h
+/// \brief Classes for the VMAC message authentication code
+/// \since Crypto++ 5.5
#ifndef CRYPTOPP_VMAC_H
#define CRYPTOPP_VMAC_H
@@ -19,9 +19,9 @@ NAMESPACE_BEGIN(CryptoPP)
-//! \class VMAC_Base
-//! \brief VMAC message authentication code base class
-//! \since Crypto++ 5.5
+/// \class VMAC_Base
+/// \brief VMAC message authentication code base class
+/// \since Crypto++ 5.5
class VMAC_Base : public IteratedHashBase<word64, MessageAuthenticationCode>
{
public:
@@ -64,17 +64,17 @@ protected: unsigned int m_L1KeyLength;
};
-//! \class VMAC
-//! \brief VMAC message authentication code
-//! \tparam T_BlockCipher block cipher
-//! \tparam T_DigestBitSize digest size, in bits
-//! \details VMAC is a block cipher-based message authentication code algorithm
-//! using a universal hash proposed by Ted Krovetz and Wei Dai in April 2007. The
-//! algorithm was designed for high performance backed by a formal analysis.
-//! \details The implementation is based on Ted Krovetz's public domain vmac.c
-//! and <a href="http://tools.ietf.org/html/draft-krovetz-vmac-01">draft-krovetz-vmac-01.txt</a>.
-//! \sa <a href="http://www.cryptolounge.org/wiki/VMAC">VMAC</a>.
-//! \since Crypto++ 5.5
+/// \class VMAC
+/// \brief VMAC message authentication code
+/// \tparam T_BlockCipher block cipher
+/// \tparam T_DigestBitSize digest size, in bits
+/// \details VMAC is a block cipher-based message authentication code algorithm
+/// using a universal hash proposed by Ted Krovetz and Wei Dai in April 2007. The
+/// algorithm was designed for high performance backed by a formal analysis.
+/// \details The implementation is based on Ted Krovetz's public domain vmac.c
+/// and <a href="http://tools.ietf.org/html/draft-krovetz-vmac-01">draft-krovetz-vmac-01.txt</a>.
+/// \sa <a href="http://www.cryptolounge.org/wiki/VMAC">VMAC</a>.
+/// \since Crypto++ 5.5
template <class T_BlockCipher, int T_DigestBitSize = 128>
class VMAC : public SimpleKeyingInterfaceImpl<VMAC_Base, SameKeyLengthAs<T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE> >
{
|