summaryrefslogtreecommitdiff
path: root/eax.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2017-11-29 10:54:33 -0500
committerJeffrey Walton <noloader@gmail.com>2017-11-29 10:54:33 -0500
commit61ec50dabe14c5d4582ac187706ea27645b3562b (patch)
tree18a2eebb7adc8c9556ce132d7081a105fa058d6b /eax.h
parent16ebfa72bf130c4725e652e4d3688d97d3feb0ee (diff)
downloadcryptopp-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 'eax.h')
-rw-r--r--eax.h40
1 files changed, 20 insertions, 20 deletions
diff --git a/eax.h b/eax.h
index 3a17658b..f9917fe1 100644
--- a/eax.h
+++ b/eax.h
@@ -1,7 +1,7 @@
// eax.h - originally written and placed in the public domain by Wei Dai
-//! \file eax.h
-//! \brief EAX block cipher mode of operation
+/// \file eax.h
+/// \brief EAX block cipher mode of operation
#ifndef CRYPTOPP_EAX_H
#define CRYPTOPP_EAX_H
@@ -12,10 +12,10 @@
NAMESPACE_BEGIN(CryptoPP)
-//! \class EAX_Base
-//! \brief EAX block cipher base implementation
-//! \details Base implementation of the AuthenticatedSymmetricCipher interface
-//! \since Crypto++ 5.6.0
+/// \class EAX_Base
+/// \brief EAX block cipher base implementation
+/// \details Base implementation of the AuthenticatedSymmetricCipher interface
+/// \since Crypto++ 5.6.0
class CRYPTOPP_NO_VTABLE EAX_Base : public AuthenticatedSymmetricCipherBase
{
public:
@@ -67,11 +67,11 @@ protected:
CTR_Mode_ExternalCipher::Encryption m_ctr;
};
-//! \class EAX_Final
-//! \brief EAX block cipher final implementation
-//! \tparam T_BlockCipher block cipher
-//! \tparam T_IsEncryption direction in which to operate the cipher
-//! \since Crypto++ 5.6.0
+/// \class EAX_Final
+/// \brief EAX block cipher final implementation
+/// \tparam T_BlockCipher block cipher
+/// \tparam T_IsEncryption direction in which to operate the cipher
+/// \since Crypto++ 5.6.0
template <class T_BlockCipher, bool T_IsEncryption>
class EAX_Final : public EAX_Base
{
@@ -90,15 +90,15 @@ private:
#undef EAX
#endif
-//! \class EAX
-//! \brief EAX block cipher mode of operation
-//! \tparam T_BlockCipher block cipher
-//! \details \p EAX provides the \p Encryption and \p Decryption typedef. See EAX_Base
-//! and EAX_Final for the AuthenticatedSymmetricCipher implementation.
-//! \sa <a href="http://www.cryptopp.com/wiki/EAX_Mode">EAX Mode</a> and
-//! <A HREF="http://www.cryptopp.com/wiki/Modes_of_Operation">Modes of Operation</A>
-//! on the Crypto++ wiki.
-//! \since Crypto++ 5.6.0
+/// \class EAX
+/// \brief EAX block cipher mode of operation
+/// \tparam T_BlockCipher block cipher
+/// \details \p EAX provides the \p Encryption and \p Decryption typedef. See EAX_Base
+/// and EAX_Final for the AuthenticatedSymmetricCipher implementation.
+/// \sa <a href="http://www.cryptopp.com/wiki/EAX_Mode">EAX Mode</a> and
+/// <A HREF="http://www.cryptopp.com/wiki/Modes_of_Operation">Modes of Operation</A>
+/// on the Crypto++ wiki.
+/// \since Crypto++ 5.6.0
template <class T_BlockCipher>
struct EAX : public AuthenticatedSymmetricCipherDocumentation
{