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 /cast.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 'cast.h')
-rw-r--r-- | cast.h | 44 |
1 files changed, 22 insertions, 22 deletions
@@ -1,7 +1,7 @@ // cast.h - originally written and placed in the public domain by Wei Dai
-//! \file cast.h
-//! \brief Classes for the CAST-128 and CAST-256 block ciphers
+/// \file cast.h
+/// \brief Classes for the CAST-128 and CAST-256 block ciphers
#ifndef CRYPTOPP_CAST_H
#define CRYPTOPP_CAST_H
@@ -11,28 +11,28 @@ NAMESPACE_BEGIN(CryptoPP)
-//! \class CAST
-//! \brief CAST block cipher base
+/// \class CAST
+/// \brief CAST block cipher base
class CAST
{
protected:
static const word32 S[8][256];
};
-//! \class CAST128_Info
-//! \brief CAST128 block cipher information
+/// \class CAST128_Info
+/// \brief CAST128 block cipher information
struct CAST128_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 5, 16>
{
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "CAST-128";}
};
-//! \class CAST128
-//! \brief CAST128 block cipher
-//! \sa <a href="http://www.cryptopp.com/wiki/CAST-128">CAST-128</a>
+/// \class CAST128
+/// \brief CAST128 block cipher
+/// \sa <a href="http://www.cryptopp.com/wiki/CAST-128">CAST-128</a>
class CAST128 : public CAST128_Info, public BlockCipherDocumentation
{
- //! \class Base
- //! \brief CAST128 block cipher default operation
+ /// \class Base
+ /// \brief CAST128 block cipher default operation
class CRYPTOPP_NO_VTABLE Base : public CAST, public BlockCipherImpl<CAST128_Info>
{
public:
@@ -43,16 +43,16 @@ class CAST128 : public CAST128_Info, public BlockCipherDocumentation FixedSizeSecBlock<word32, 32> K;
};
- //! \class Enc
- //! \brief CAST128 block cipher encryption operation
+ /// \class Enc
+ /// \brief CAST128 block cipher encryption operation
class CRYPTOPP_NO_VTABLE Enc : public Base
{
public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
};
- //! \class Dec
- //! \brief CAST128 block cipher decryption operation
+ /// \class Dec
+ /// \brief CAST128 block cipher decryption operation
class CRYPTOPP_NO_VTABLE Dec : public Base
{
public:
@@ -64,20 +64,20 @@ public: typedef BlockCipherFinal<DECRYPTION, Dec> Decryption;
};
-//! \class CAST256_Info
-//! \brief CAST256 block cipher information
+/// \class CAST256_Info
+/// \brief CAST256 block cipher information
struct CAST256_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 16, 32, 4>
{
CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "CAST-256";}
};
-//! \class CAST256
-//! \brief CAST256 block cipher
-//! \sa <a href="http://www.cryptopp.com/wiki/CAST-256">CAST-256</a>
+/// \class CAST256
+/// \brief CAST256 block cipher
+/// \sa <a href="http://www.cryptopp.com/wiki/CAST-256">CAST-256</a>
class CAST256 : public CAST256_Info, public BlockCipherDocumentation
{
- //! \class Base
- //! \brief CAST256 block cipher default operation
+ /// \class Base
+ /// \brief CAST256 block cipher default operation
class CRYPTOPP_NO_VTABLE Base : public CAST, public BlockCipherImpl<CAST256_Info>
{
public:
|