Change Doxygen comment style from //! to ///

Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw

1 files changed, 41 insertions, 41 deletions

diff --git a/des.h b/des.h
index e526ede5..e4171988 100644
--- a/des.h
+++ b/des.h
@@ -1,7 +1,7 @@
 // des.h - originally written and placed in the public domain by Wei Dai

 

-//! \file des.h

-//! \brief Classes for DES, 2-key Triple-DES, 3-key Triple-DES and DESX

+/// \file des.h

+/// \brief Classes for DES, 2-key Triple-DES, 3-key Triple-DES and DESX

 

 #ifndef CRYPTOPP_DES_H

 #define CRYPTOPP_DES_H

@@ -11,8 +11,8 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class RawDES

-//! \brief DES block cipher base class

+/// \class RawDES

+/// \brief DES block cipher base class

 class CRYPTOPP_DLL RawDES

 {

 public:

@@ -25,25 +25,25 @@ protected:
 	FixedSizeSecBlock<word32, 32> k;

 };

 

-//! \class DES_Info

-//! \brief DES block cipher information

+/// \class DES_Info

+/// \brief DES block cipher information

 struct DES_Info : public FixedBlockSize<8>, public FixedKeyLength<8>

 {

 	// disable DES in DLL version by not exporting this function

 	CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "DES";}

 };

 

-//! \class DES

-//! \brief DES block cipher

-//! \details The DES implementation in Crypto++ ignores the parity bits

-//!   (the least significant bits of each byte) in the key. However you can use CheckKeyParityBits()

-//!   and CorrectKeyParityBits() to	check or correct the parity bits if you wish.

-//! \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES</a>

-//! \since Crypto++ 1.0

+/// \class DES

+/// \brief DES block cipher

+/// \details The DES implementation in Crypto++ ignores the parity bits

+///   (the least significant bits of each byte) in the key. However you can use CheckKeyParityBits()

+///   and CorrectKeyParityBits() to	check or correct the parity bits if you wish.

+/// \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES</a>

+/// \since Crypto++ 1.0

 class DES : public DES_Info, public BlockCipherDocumentation

 {

-	//! \class Base

-	//! \brief DES block cipher default operation

+	/// \class Base

+	/// \brief DES block cipher default operation

 	class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<DES_Info>, public RawDES

 	{

 	public:

@@ -52,30 +52,30 @@ class DES : public DES_Info, public BlockCipherDocumentation
 	};

 

 public:

-	//! check DES key parity bits

+	/// check DES key parity bits

 	static bool CheckKeyParityBits(const byte *key);

-	//! correct DES key parity bits

+	/// correct DES key parity bits

 	static void CorrectKeyParityBits(byte *key);

 

 	typedef BlockCipherFinal<ENCRYPTION, Base> Encryption;

 	typedef BlockCipherFinal<DECRYPTION, Base> Decryption;

 };

 

-//! \class DES_EDE2_Info

-//! \brief 2-key TripleDES block cipher information

+/// \class DES_EDE2_Info

+/// \brief 2-key TripleDES block cipher information

 struct DES_EDE2_Info : public FixedBlockSize<8>, public FixedKeyLength<16>

 {

 	CRYPTOPP_DLL static const char * CRYPTOPP_API StaticAlgorithmName() {return "DES-EDE2";}

 };

 

-//! \class DES_EDE2

-//! \brief 2-key TripleDES block cipher

-//! \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-EDE2</a>

-//! \since Crypto++ 1.0

+/// \class DES_EDE2

+/// \brief 2-key TripleDES block cipher

+/// \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-EDE2</a>

+/// \since Crypto++ 1.0

 class DES_EDE2 : public DES_EDE2_Info, public BlockCipherDocumentation

 {

-	//! \class Base

-	//! \brief DES_EDE2 block cipher default operation

+	/// \class Base

+	/// \brief DES_EDE2 block cipher default operation

 	class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<DES_EDE2_Info>

 	{

 	public:

@@ -91,21 +91,21 @@ public:
 	typedef BlockCipherFinal<DECRYPTION, Base> Decryption;

 };

 

-//! \class DES_EDE3_Info

-//! \brief 3-key TripleDES block cipher information

+/// \class DES_EDE3_Info

+/// \brief 3-key TripleDES block cipher information

 struct DES_EDE3_Info : public FixedBlockSize<8>, public FixedKeyLength<24>

 {

 	CRYPTOPP_DLL static const char * CRYPTOPP_API StaticAlgorithmName() {return "DES-EDE3";}

 };

 

-//! \class DES_EDE3

-//! \brief 3-key TripleDES block cipher

-//! \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-EDE3</a>

-//! \since Crypto++ 1.0

+/// \class DES_EDE3

+/// \brief 3-key TripleDES block cipher

+/// \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-EDE3</a>

+/// \since Crypto++ 1.0

 class DES_EDE3 : public DES_EDE3_Info, public BlockCipherDocumentation

 {

-	//! \class Base

-	//! \brief DES_EDE3 block cipher default operation

+	/// \class Base

+	/// \brief DES_EDE3 block cipher default operation

 	class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<DES_EDE3_Info>

 	{

 	public:

@@ -121,21 +121,21 @@ public:
 	typedef BlockCipherFinal<DECRYPTION, Base> Decryption;

 };

 

-//! \class DES_XEX3_Info

-//! \brief DESX block cipher information

+/// \class DES_XEX3_Info

+/// \brief DESX block cipher information

 struct DES_XEX3_Info : public FixedBlockSize<8>, public FixedKeyLength<24>

 {

 	CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "DES-XEX3";}

 };

 

-//! \class DES_XEX3

-//! \brief DESX block cipher

-//! \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-XEX3</a>, AKA DESX

-//! \since Crypto++ 1.0

+/// \class DES_XEX3

+/// \brief DESX block cipher

+/// \sa <a href="http://www.cryptopp.com/wiki/TripleDES">DES-XEX3</a>, AKA DESX

+/// \since Crypto++ 1.0

 class DES_XEX3 : public DES_XEX3_Info, public BlockCipherDocumentation

 {

-	//! \class Base

-	//! \brief DES_XEX3 block cipher default operation

+	/// \class Base

+	/// \brief DES_XEX3 block cipher default operation

 	class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<DES_XEX3_Info>

 	{

 	public: