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

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

1 files changed, 65 insertions, 65 deletions

diff --git a/luc.h b/luc.h
index adea781f..45f322b8 100644
--- a/luc.h
+++ b/luc.h
@@ -1,10 +1,10 @@
 // luc.h - originally written and placed in the public domain by Wei Dai

 

-//! \file luc.h

-//! \brief Classes for the LUC cryptosystem

-//! \details This class is here for historical and pedagogical interest. It has no practical advantages over other

-//!   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

-//!   defined later in this .h file may be of more practical interest.

+/// \file luc.h

+/// \brief Classes for the LUC cryptosystem

+/// \details This class is here for historical and pedagogical interest. It has no practical advantages over other

+///   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

+///   defined later in this .h file may be of more practical interest.

 

 #ifndef CRYPTOPP_LUC_H

 #define CRYPTOPP_LUC_H

@@ -29,10 +29,10 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \brief The LUC function.

-//! \details This class is here for historical and pedagogical interest. It has no practical advantages over other

-//!   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

-//!   defined later in this .h file may be of more practical interest.

+/// \brief The LUC function.

+/// \details This class is here for historical and pedagogical interest. It has no practical advantages over other

+///   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

+///   defined later in this .h file may be of more practical interest.

 class LUCFunction : public TrapdoorFunction, public PublicKey

 {

 	typedef LUCFunction ThisClass;

@@ -40,9 +40,9 @@ class LUCFunction : public TrapdoorFunction, public PublicKey
 public:

 	virtual ~LUCFunction() {}

 

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

-	//! \param n the modulus

-	//! \param e the public exponent

+	/// \brief Initialize a LUC 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;}

 

@@ -68,10 +68,10 @@ protected:
 	Integer m_n, m_e;

 };

 

-//! \brief The LUC inverse function.

-//! \details This class is here for historical and pedagogical interest. It has no practical advantages over other

-//!   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

-//!   defined later in this .h file may be of more practical interest.

+/// \brief The LUC inverse function.

+/// \details This class is here for historical and pedagogical interest. It has no practical advantages over other

+///   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

+///   defined later in this .h file may be of more practical interest.

 class InvertibleLUCFunction : public LUCFunction, public TrapdoorFunctionInverse, public PrivateKey

 {

 	typedef InvertibleLUCFunction ThisClass;

@@ -79,23 +79,23 @@ class InvertibleLUCFunction : public LUCFunction, public TrapdoorFunctionInverse
 public:

 	virtual ~InvertibleLUCFunction() {}

 

-	//! \brief Create a LUC private key

-	//! \param rng a RandomNumberGenerator derived class

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

-	//! \param eStart the desired starting public exponent

-	//! \details Initialize() creates a new keypair using a starting public exponent of 17.

-	//! \details This function overload of Initialize() creates a new keypair 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 LUC private key

+	/// \param rng a RandomNumberGenerator derived class

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

+	/// \param eStart the desired starting public exponent

+	/// \details Initialize() creates a new keypair using a starting public exponent of 17.

+	/// \details This function overload of Initialize() creates a new keypair 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, const Integer &eStart=17);

 

-	//! \brief Initialize a LUC private key with {n,e,p,q,dp,dq,u}

-	//! \param n modulus

-	//! \param e public exponent

-	//! \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 LUC private key with {n,e,p,q,dp,dq,u}

+	/// \param n modulus

+	/// \param e public exponent

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

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

 

@@ -130,22 +130,22 @@ struct LUC
 	typedef InvertibleLUCFunction PrivateKey;

 };

 

-//! \brief LUC cryptosystem

-//! \tparam STANDARD signature standard

-//! \details This class is here for historical and pedagogical interest. It has no practical advantages over other

-//!   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

-//!   defined later in this .h file may be of more practical interest.

+/// \brief LUC cryptosystem

+/// \tparam STANDARD signature standard

+/// \details This class is here for historical and pedagogical interest. It has no practical advantages over other

+///   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

+///   defined later in this .h file may be of more practical interest.

 template <class STANDARD>

 struct LUCES : public TF_ES<LUC, STANDARD>

 {

 };

 

-//! \brief LUC signature scheme with appendix

-//! \tparam STANDARD signature standard

-//! \tparam H hash transformation

-//! \details This class is here for historical and pedagogical interest. It has no practical advantages over other

-//!   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

-//!   defined later in this .h file may be of more practical interest.

+/// \brief LUC signature scheme with appendix

+/// \tparam STANDARD signature standard

+/// \tparam H hash transformation

+/// \details This class is here for historical and pedagogical interest. It has no practical advantages over other

+///   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

+///   defined later in this .h file may be of more practical interest.

 template <class STANDARD, class H>

 struct LUCSS : public TF_SS<LUC, STANDARD, H>

 {

@@ -178,7 +178,7 @@ private:
 	Integer m_p;

 };

 

-//! _

+/// _

 class DL_BasePrecomputation_LUC : public DL_FixedBasePrecomputation<Integer>

 {

 public:

@@ -208,8 +208,8 @@ private:
 	Integer m_g;

 };

 

-//! \class DL_GroupParameters_LUC

-//! \brief LUC GroupParameters specialization

+/// \class DL_GroupParameters_LUC

+/// \brief LUC GroupParameters specialization

 class DL_GroupParameters_LUC : public DL_GroupParameters_IntegerBasedImpl<DL_GroupPrecomputation_LUC, DL_BasePrecomputation_LUC>

 {

 public:

@@ -239,8 +239,8 @@ private:
 	int GetFieldType() const {return 2;}

 };

 

-//! \class DL_GroupParameters_LUC_DefaultSafePrime

-//! \brief GF(p) group parameters that default to safe primes

+/// \class DL_GroupParameters_LUC_DefaultSafePrime

+/// \brief GF(p) group parameters that default to safe primes

 class DL_GroupParameters_LUC_DefaultSafePrime : public DL_GroupParameters_LUC

 {

 public:

@@ -250,8 +250,8 @@ protected:
 	unsigned int GetDefaultSubgroupOrderSize(unsigned int modulusSize) const {return modulusSize-1;}

 };

 

-//! \class DL_Algorithm_LUC_HMP

-//! \brief LUC HMP signature algorithm

+/// \class DL_Algorithm_LUC_HMP

+/// \brief LUC HMP signature algorithm

 class DL_Algorithm_LUC_HMP : public DL_ElgamalLikeSignatureAlgorithm<Integer>

 {

 public:

@@ -266,7 +266,7 @@ public:
 		{return params.GetGroupOrder().ByteCount();}

 };

 

-//! \brief LUC signature keys

+/// \brief LUC signature keys

 struct DL_SignatureKeys_LUC

 {

 	typedef DL_GroupParameters_LUC GroupParameters;

@@ -274,17 +274,17 @@ struct DL_SignatureKeys_LUC
 	typedef DL_PrivateKey_GFP<GroupParameters> PrivateKey;

 };

 

-//! \brief LUC-HMP, based on "Digital signature schemes based on Lucas functions" by Patrick Horster, Markus Michels, Holger Petersen

-//! \tparam H hash transformation

-//! \details This class is here for historical and pedagogical interest. It has no practical advantages over other

-//!   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

-//!   defined later in this .h file may be of more practical interest.

+/// \brief LUC-HMP, based on "Digital signature schemes based on Lucas functions" by Patrick Horster, Markus Michels, Holger Petersen

+/// \tparam H hash transformation

+/// \details This class is here for historical and pedagogical interest. It has no practical advantages over other

+///   trapdoor functions and probably shouldn't	be used in production software. The discrete log based LUC schemes

+///   defined later in this .h file may be of more practical interest.

 template <class H>

 struct LUC_HMP : public DL_SS<DL_SignatureKeys_LUC, DL_Algorithm_LUC_HMP, DL_SignatureMessageEncodingMethod_DSA, H>

 {

 };

 

-//! \brief LUC encryption keys

+/// \brief LUC encryption keys

 struct DL_CryptoKeys_LUC

 {

 	typedef DL_GroupParameters_LUC_DefaultSafePrime GroupParameters;

@@ -292,14 +292,14 @@ struct DL_CryptoKeys_LUC
 	typedef DL_PrivateKey_GFP<GroupParameters> PrivateKey;

 };

 

-//! \class LUC-IES

-//! \brief LUC Integrated Encryption Scheme

-//! \tparam COFACTOR_OPTION cofactor multiplication option

-//! \tparam HASH HashTransformation derived class used for key drivation and MAC computation

-//! \tparam DHAES_MODE flag indicating if the MAC includes additional context parameters such as <em>u·V</em>, <em>v·U</em> and label

-//! \tparam LABEL_OCTETS flag indicating if the label size is specified in octets or bits

-//! \sa CofactorMultiplicationOption

-//! \since Crypto++ 4.0, Crypto++ 5.7 for Bouncy Castle and Botan compatibility

+/// \class LUC-IES

+/// \brief LUC Integrated Encryption Scheme

+/// \tparam COFACTOR_OPTION cofactor multiplication option

+/// \tparam HASH HashTransformation derived class used for key drivation and MAC computation

+/// \tparam DHAES_MODE flag indicating if the MAC includes additional context parameters such as <em>u·V</em>, <em>v·U</em> and label

+/// \tparam LABEL_OCTETS flag indicating if the label size is specified in octets or bits

+/// \sa CofactorMultiplicationOption

+/// \since Crypto++ 4.0, Crypto++ 5.7 for Bouncy Castle and Botan compatibility

 template <class HASH = SHA1, class COFACTOR_OPTION = NoCofactorMultiplication, bool DHAES_MODE = true, bool LABEL_OCTETS = false>

 struct LUC_IES

 	: public DL_ES<

@@ -314,7 +314,7 @@ struct LUC_IES
 

 // ********************************************************

 

-//! LUC-DH

+/// LUC-DH

 typedef DH_Domain<DL_GroupParameters_LUC_DefaultSafePrime> LUC_DH;

 

 NAMESPACE_END