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

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

1 files changed, 36 insertions, 36 deletions

diff --git a/esign.h b/esign.h
index dcda42c4..7faeca55 100644
--- a/esign.h
+++ b/esign.h
@@ -1,8 +1,8 @@
 // esign.h - originally written and placed in the public domain by Wei Dai

 

-//! \file esign.h

-//! \brief Classes providing ESIGN signature schemes as defined in IEEE P1363a

-//! \since Crypto++ 5.0

+/// \file esign.h

+/// \brief Classes providing ESIGN signature schemes as defined in IEEE P1363a

+/// \since Crypto++ 5.0

 

 #ifndef CRYPTOPP_ESIGN_H

 #define CRYPTOPP_ESIGN_H

@@ -15,18 +15,18 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class ESIGNFunction

-//! \brief ESIGN trapdoor function using the public key

-//! \since Crypto++ 5.0

+/// \class ESIGNFunction

+/// \brief ESIGN trapdoor function using the public key

+/// \since Crypto++ 5.0

 class ESIGNFunction : public TrapdoorFunction, public ASN1CryptoMaterial<PublicKey>

 {

 	typedef ESIGNFunction ThisClass;

 

 public:

 

-	//! \brief Initialize a ESIGN public key with {n,e}

-	//! \param n the modulus

-	//! \param e the public exponent

+	/// \brief Initialize a ESIGN public key with {n,e}

+	/// \param n the modulus

+	/// \param e the public exponent

 	void Initialize(const Integer &n, const Integer &e)

 		{m_n = n; m_e = e;}

 

@@ -58,30 +58,30 @@ protected:
 	Integer m_n, m_e;

 };

 

-//! \class InvertibleESIGNFunction

-//! \brief ESIGN trapdoor function using the private key

-//! \since Crypto++ 5.0

+/// \class InvertibleESIGNFunction

+/// \brief ESIGN trapdoor function using the private key

+/// \since Crypto++ 5.0

 class InvertibleESIGNFunction : public ESIGNFunction, public RandomizedTrapdoorFunctionInverse, public PrivateKey

 {

 	typedef InvertibleESIGNFunction ThisClass;

 

 public:

 

-	//! \brief Initialize a ESIGN private key with {n,e,p,q}

-	//! \param n modulus

-	//! \param e public exponent

-	//! \param p first prime factor

-	//! \param q second prime factor

-	//! \details This Initialize() function overload initializes a private key from existing parameters.

+	/// \brief Initialize a ESIGN private key with {n,e,p,q}

+	/// \param n modulus

+	/// \param e public exponent

+	/// \param p first prime factor

+	/// \param q second prime factor

+	/// \details This Initialize() function overload initializes a private key from existing parameters.

 	void Initialize(const Integer &n, const Integer &e, const Integer &p, const Integer &q)

 		{m_n = n; m_e = e; m_p = p; m_q = q;}

 

-	//! \brief Create a ESIGN private key

-	//! \param rng a RandomNumberGenerator derived class

-	//! \param modulusBits the size of the modulud, in bits

-	//! \details This function overload of Initialize() creates a new private key because it

-	//!   takes a RandomNumberGenerator() as a parameter. If you have an existing keypair,

-	//!   then use one of the other Initialize() overloads.

+	/// \brief Create a ESIGN private key

+	/// \param rng a RandomNumberGenerator derived class

+	/// \param modulusBits the size of the modulud, in bits

+	/// \details This function overload of Initialize() creates a new private key because it

+	///   takes a RandomNumberGenerator() as a parameter. If you have an existing keypair,

+	///   then use one of the other Initialize() overloads.

 	void Initialize(RandomNumberGenerator &rng, unsigned int modulusBits)

 		{GenerateRandomWithKeySize(rng, modulusBits);}

 

@@ -115,10 +115,10 @@ protected:
 	Integer m_p, m_q;

 };

 

-//! \class EMSA5Pad

-//! \brief EMSA5 padding method

-//! \tparam T Mask Generation Function

-//! \since Crypto++ 5.0

+/// \class EMSA5Pad

+/// \brief EMSA5 padding method

+/// \tparam T Mask Generation Function

+/// \since Crypto++ 5.0

 template <class T>

 class EMSA5Pad : public PK_DeterministicSignatureMessageEncodingMethod

 {

@@ -142,9 +142,9 @@ public:
 	}

 };

 

-//! \class P1363_EMSA5

-//! \brief EMSA5 padding method, for use with ESIGN

-//! \since Crypto++ 5.0

+/// \class P1363_EMSA5

+/// \brief EMSA5 padding method, for use with ESIGN

+/// \since Crypto++ 5.0

 struct P1363_EMSA5 : public SignatureStandard

 {

 	typedef EMSA5Pad<P1363_MGF1> SignatureMessageEncodingMethod;

@@ -157,11 +157,11 @@ struct ESIGN_Keys
 	typedef InvertibleESIGNFunction PrivateKey;

 };

 

-//! \class ESIGN

-//! \brief ESIGN signature scheme, IEEE P1363a

-//! \tparam H HashTransformation derived class

-//! \tparam STANDARD Signature encoding method

-//! \since Crypto++ 5.0

+/// \class ESIGN

+/// \brief ESIGN signature scheme, IEEE P1363a

+/// \tparam H HashTransformation derived class

+/// \tparam STANDARD Signature encoding method

+/// \since Crypto++ 5.0

 template <class H, class STANDARD = P1363_EMSA5>

 struct ESIGN : public TF_SS<ESIGN_Keys, STANDARD, H>

 {