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

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

1 files changed, 22 insertions, 22 deletions

diff --git a/rc2.h b/rc2.h
index 2da4ae49..9a6541ad 100644
--- a/rc2.h
+++ b/rc2.h
@@ -1,7 +1,7 @@
 // rc2.h - originally written and placed in the public domain by Wei Dai

 

-//! \file rc2.h

-//! \brief Classes for the RC2 block cipher

+/// \file rc2.h

+/// \brief Classes for the RC2 block cipher

 

 #ifndef CRYPTOPP_RC2_H

 #define CRYPTOPP_RC2_H

@@ -12,8 +12,8 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class RC2_Info

-//! \brief RC2 block cipher information

+/// \class RC2_Info

+/// \brief RC2 block cipher information

 struct RC2_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 1, 128>

 {

 	CRYPTOPP_CONSTANT(DEFAULT_EFFECTIVE_KEYLENGTH = 1024)

@@ -21,14 +21,14 @@ struct RC2_Info : public FixedBlockSize<8>, public VariableKeyLength<16, 1, 128>
 	CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() {return "RC2";}

 };

 

-//! \class RC2

-//! \brief RC2 block cipher

-//! \sa <a href="http://www.cryptopp.com/wiki/RC2">RC2</a> on the Crypto Lounge.

+/// \class RC2

+/// \brief RC2 block cipher

+/// \sa <a href="http://www.cryptopp.com/wiki/RC2">RC2</a> on the Crypto Lounge.

 class RC2 : public RC2_Info, public BlockCipherDocumentation

 {

-	//! \class Base

-	//! \brief Class specific methods used to operate the cipher.

-	//! \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions

+	/// \class Base

+	/// \brief Class specific methods used to operate the cipher.

+	/// \details Implementations and overrides in \p Base apply to both \p ENCRYPTION and \p DECRYPTION directions

 	class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<RC2_Info>

 	{

 	public:

@@ -39,18 +39,18 @@ class RC2 : public RC2_Info, public BlockCipherDocumentation
 		FixedSizeSecBlock<word16, 64> K;  // expanded key table

 	};

 

-	//! \class Enc

-	//! \brief Class specific methods used to operate the cipher in the forward direction.

-	//! \details Implementations and overrides in \p Enc apply to \p ENCRYPTION.

+	/// \class Enc

+	/// \brief Class specific methods used to operate the cipher in the forward direction.

+	/// \details Implementations and overrides in \p Enc apply to \p ENCRYPTION.

 	class CRYPTOPP_NO_VTABLE Enc : public Base

 	{

 	public:

 		void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;

 	};

 

-	//! \class Dec

-	//! \brief Class specific methods used to operate the cipher in the reverse direction.

-	//! \details Implementations and overrides in \p Dec apply to \p DECRYPTION.

+	/// \class Dec

+	/// \brief Class specific methods used to operate the cipher in the reverse direction.

+	/// \details Implementations and overrides in \p Dec apply to \p DECRYPTION.

 	class CRYPTOPP_NO_VTABLE Dec : public Base

 	{

 	public:

@@ -59,9 +59,9 @@ class RC2 : public RC2_Info, public BlockCipherDocumentation
 

 public:

 

-	//! \class Encryption

-	//! \brief Class specific methods used to operate the cipher in the forward direction.

-	//! \details Implementations and overrides in \p Encryption apply to \p ENCRYPTION.

+	/// \class Encryption

+	/// \brief Class specific methods used to operate the cipher in the forward direction.

+	/// \details Implementations and overrides in \p Encryption apply to \p ENCRYPTION.

 	class Encryption : public BlockCipherFinal<ENCRYPTION, Enc>

 	{

 	public:

@@ -72,9 +72,9 @@ public:
 			{SetKey(key, keyLen, MakeParameters("EffectiveKeyLength", effectiveKeyLen));}

 	};

 

-	//! \class Decryption

-	//! \brief Class specific methods used to operate the cipher in the reverse direction.

-	//! \details Implementations and overrides in \p Decryption apply to \p DECRYPTION.

+	/// \class Decryption

+	/// \brief Class specific methods used to operate the cipher in the reverse direction.

+	/// \details Implementations and overrides in \p Decryption apply to \p DECRYPTION.

 	class Decryption : public BlockCipherFinal<DECRYPTION, Dec>

 	{

 	public: