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/rw.h b/rw.h
index 5fcfddf4..f6274c9d 100644
--- a/rw.h
+++ b/rw.h
@@ -1,12 +1,12 @@
 // rw.h - originally written and placed in the public domain by Wei Dai

 

-//! \file rw.h

-//! \brief Classes for Rabin-Williams signature scheme

-//! \details The implementation provides Rabin-Williams signature schemes as defined in

-//!   IEEE P1363. It uses Bernstein's tweaked square roots in place of square roots to

-//!   speedup calculations.

-//! \sa <A HREF="http://cr.yp.to/sigs/rwsota-20080131.pdf">RSA signatures and Rabin–Williams

-//!   signatures: the state of the art (20080131)</A>, Section 6, <em>The tweaks e and f</em>.

+/// \file rw.h

+/// \brief Classes for Rabin-Williams signature scheme

+/// \details The implementation provides Rabin-Williams signature schemes as defined in

+///   IEEE P1363. It uses Bernstein's tweaked square roots in place of square roots to

+///   speedup calculations.

+/// \sa <A HREF="http://cr.yp.to/sigs/rwsota-20080131.pdf">RSA signatures and Rabin–Williams

+///   signatures: the state of the art (20080131)</A>, Section 6, <em>The tweaks e and f</em>.

 

 #ifndef CRYPTOPP_RW_H

 #define CRYPTOPP_RW_H

@@ -17,17 +17,17 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class RWFunction

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

-//! \since Crypto++ 2.0, Tweaked roots using <em>e</em> and <em>f</em> since Crypto++ 5.6.4

+/// \class RWFunction

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

+/// \since Crypto++ 2.0, Tweaked roots using <em>e</em> and <em>f</em> since Crypto++ 5.6.4

 class CRYPTOPP_DLL RWFunction : public TrapdoorFunction, public PublicKey

 {

 	typedef RWFunction ThisClass;

 

 public:

 

-	//! \brief Initialize a Rabin-Williams public key

-	//! \param n the modulus

+	/// \brief Initialize a Rabin-Williams public key

+	/// \param n the modulus

 	void Initialize(const Integer &n)

 		{m_n = n;}

 

@@ -54,31 +54,31 @@ protected:
 	Integer m_n;

 };

 

-//! \class InvertibleRWFunction

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

-//! \since Crypto++ 2.0, Tweaked roots using <em>e</em> and <em>f</em> since Crypto++ 5.6.4

+/// \class InvertibleRWFunction

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

+/// \since Crypto++ 2.0, Tweaked roots using <em>e</em> and <em>f</em> since Crypto++ 5.6.4

 class CRYPTOPP_DLL InvertibleRWFunction : public RWFunction, public TrapdoorFunctionInverse, public PrivateKey

 {

 	typedef InvertibleRWFunction ThisClass;

 

 public:

-	//! \brief Construct an InvertibleRWFunction

+	/// \brief Construct an InvertibleRWFunction

 	InvertibleRWFunction() : m_precompute(false) {}

 

-	//! \brief Initialize a Rabin-Williams private key

-	//! \param n modulus

-	//! \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-Williams private key

+	/// \param n modulus

+	/// \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 &p, const Integer &q, const Integer &u);

 

-	//! \brief Create a Rabin-Williams private key

-	//! \param rng a RandomNumberGenerator derived class

-	//! \param modulusBits the size of the modulus, 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-Williams private key

+	/// \param rng a RandomNumberGenerator derived class

+	/// \param modulusBits the size of the modulus, 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);}

 

@@ -124,7 +124,7 @@ protected:
 	mutable bool m_precompute;

 };

 

-//! \brief Rabin-Williams keys

+/// \brief Rabin-Williams keys

 struct RW

 {

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

@@ -132,9 +132,9 @@ struct RW
 	typedef InvertibleRWFunction PrivateKey;

 };

 

-//! \brief Rabin-Williams signature scheme

-//! \tparam STANDARD signature standard

-//! \tparam H hash transformation

+/// \brief Rabin-Williams signature scheme

+/// \tparam STANDARD signature standard

+/// \tparam H hash transformation

 template <class STANDARD, class H>

 struct RWSS : public TF_SS<RW, STANDARD, H>

 {