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

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

1 files changed, 32 insertions, 32 deletions

diff --git a/rabin.h b/rabin.h
index 30c5b69a..ad476ea3 100644
--- a/rabin.h
+++ b/rabin.h
@@ -1,7 +1,7 @@
 // rabin.h - originally written and placed in the public domain by Wei Dai

 

-//! \file rabin.h

-//! \brief Classes for Rabin encryption and signature schemes

+/// \file rabin.h

+/// \brief Classes for Rabin encryption and signature schemes

 

 #ifndef CRYPTOPP_RABIN_H

 #define CRYPTOPP_RABIN_H

@@ -13,19 +13,19 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class RabinFunction

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

-//! \since Crypto++ 2.0

+/// \class RabinFunction

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

+/// \since Crypto++ 2.0

 class RabinFunction : public TrapdoorFunction, public PublicKey

 {

 	typedef RabinFunction ThisClass;

 

 public:

 

-	//! \brief Initialize a Rabin public key

-	//! \param n the modulus

-	//! \param r element r

-	//! \param s element s

+	/// \brief Initialize a Rabin public key

+	/// \param n the modulus

+	/// \param r element r

+	/// \param s element s

 	void Initialize(const Integer &n, const Integer &r, const Integer &s)

 		{m_n = n; m_r = r; m_s = s;}

 

@@ -52,32 +52,32 @@ protected:
 	Integer m_n, m_r, m_s;

 };

 

-//! \class InvertibleRabinFunction

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

-//! \since Crypto++ 2.0

+/// \class InvertibleRabinFunction

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

+/// \since Crypto++ 2.0

 class InvertibleRabinFunction : public RabinFunction, public TrapdoorFunctionInverse, public PrivateKey

 {

 	typedef InvertibleRabinFunction ThisClass;

 

 public:

 

-	//! \brief Initialize a Rabin private key

-	//! \param n modulus

-	//! \param r element r

-	//! \param s element s

-	//! \param p first prime factor

-	//! \param q second prime factor

-	//! \param u q<sup>-1</sup> mod p

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

+	/// \brief Initialize a Rabin private key

+	/// \param n modulus

+	/// \param r element r

+	/// \param s element s

+	/// \param p first prime factor

+	/// \param q second prime factor

+	/// \param u q<sup>-1</sup> mod p

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

 	void Initialize(const Integer &n, const Integer &r, const Integer &s, const Integer &p, const Integer &q, const Integer &u)

 		{m_n = n; m_r = r; m_s = s; m_p = p; m_q = q; m_u = u;}

 

-	//! \brief Create a Rabin private key

-	//! \param rng a RandomNumberGenerator derived class

-	//! \param keybits the size of the key, 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 Rabin private key

+	/// \param rng a RandomNumberGenerator derived class

+	/// \param keybits the size of the key, 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 keybits)

 		{GenerateRandomWithKeySize(rng, keybits);}

 

@@ -104,7 +104,7 @@ protected:
 	Integer m_p, m_q, m_u;

 };

 

-//! \brief Rabin keys

+/// \brief Rabin keys

 struct Rabin

 {

 	static std::string StaticAlgorithmName() {return "Rabin-Crypto++Variant";}

@@ -112,16 +112,16 @@ struct Rabin
 	typedef InvertibleRabinFunction PrivateKey;

 };

 

-//! \brief Rabin encryption scheme

-//! \tparam STANDARD encryption standard

+/// \brief Rabin encryption scheme

+/// \tparam STANDARD encryption standard

 template <class STANDARD>

 struct RabinES : public TF_ES<Rabin, STANDARD>

 {

 };

 

-//! \brief Rabin signature scheme

-//! \tparam STANDARD signature standard

-//! \tparam H hash transformation

+/// \brief Rabin signature scheme

+/// \tparam STANDARD signature standard

+/// \tparam H hash transformation

 template <class STANDARD, class H>

 struct RabinSS : public TF_SS<Rabin, STANDARD, H>

 {