summaryrefslogtreecommitdiff
path: root/rijndael.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 /rijndael.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 'rijndael.h')
-rw-r--r--rijndael.h58
1 files changed, 29 insertions, 29 deletions
diff --git a/rijndael.h b/rijndael.h
index 61e3c5f3..413d2ebf 100644
--- a/rijndael.h
+++ b/rijndael.h
@@ -1,11 +1,11 @@
// rijndael.h - originally written and placed in the public domain by Wei Dai
-//! \file rijndael.h
-//! \brief Classes for Rijndael encryption algorithm
-//! \details All key sizes are supported. The library only provides Rijndael with 128-bit blocks,
-//! and not 192-bit or 256-bit blocks
-//! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
-//! Power8 AES since Crypto++ 6.0
+/// \file rijndael.h
+/// \brief Classes for Rijndael encryption algorithm
+/// \details All key sizes are supported. The library only provides Rijndael with 128-bit blocks,
+/// and not 192-bit or 256-bit blocks
+/// \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
+/// Power8 AES since Crypto++ 6.0
#ifndef CRYPTOPP_RIJNDAEL_H
#define CRYPTOPP_RIJNDAEL_H
@@ -20,26 +20,26 @@
NAMESPACE_BEGIN(CryptoPP)
-//! \brief Rijndael block cipher information
-//! \details All key sizes are supported. The library only provides Rijndael with 128-bit blocks,
-//! and not 192-bit or 256-bit blocks
-//! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
-//! Power8 AES since Crypto++ 6.0
+/// \brief Rijndael block cipher information
+/// \details All key sizes are supported. The library only provides Rijndael with 128-bit blocks,
+/// and not 192-bit or 256-bit blocks
+/// \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
+/// Power8 AES since Crypto++ 6.0
struct Rijndael_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 8>
{
CRYPTOPP_DLL static const char * CRYPTOPP_API StaticAlgorithmName() {return CRYPTOPP_RIJNDAEL_NAME;}
};
-//! \brief Rijndael block cipher
-//! \details All key sizes are supported. The library only provides Rijndael with 128-bit blocks,
-//! and not 192-bit or 256-bit blocks
-//! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
-//! Power8 AES since Crypto++ 6.0
-//! \sa <a href="http://www.cryptopp.com/wiki/Rijndael">Rijndael</a>
+/// \brief Rijndael block cipher
+/// \details All key sizes are supported. The library only provides Rijndael with 128-bit blocks,
+/// and not 192-bit or 256-bit blocks
+/// \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
+/// Power8 AES since Crypto++ 6.0
+/// \sa <a href="http://www.cryptopp.com/wiki/Rijndael">Rijndael</a>
class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentation
{
- //! \brief Rijndael block cipher transformation functions
- //! \details Provides implementation common to encryption and decryption
+ /// \brief Rijndael block cipher transformation functions
+ /// \details Provides implementation common to encryption and decryption
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<Rijndael_Info>
{
public:
@@ -60,11 +60,11 @@ class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentat
mutable SecByteBlock m_aliasBlock;
};
- //! \brief Provides implementation for encryption transformation
- //! \details Enc provides implementation for encryption transformation. All key sizes are supported.
- //! The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
- //! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
- //! Power8 AES since Crypto++ 6.0
+ /// \brief Provides implementation for encryption transformation
+ /// \details Enc provides implementation for encryption transformation. All key sizes are supported.
+ /// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
+ /// \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
+ /// Power8 AES since Crypto++ 6.0
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Enc : public Base
{
public:
@@ -74,11 +74,11 @@ class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentat
#endif
};
- //! \brief Provides implementation for decryption transformation
- //! \details Dec provides implementation for decryption transformation. All key sizes are supported.
- //! The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
- //! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
- //! Power8 AES since Crypto++ 6.0
+ /// \brief Provides implementation for decryption transformation
+ /// \details Dec provides implementation for decryption transformation. All key sizes are supported.
+ /// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
+ /// \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
+ /// Power8 AES since Crypto++ 6.0
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Dec : public Base
{
public: