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/ec2n.h b/ec2n.h
index cc4c0462..6de58c62 100644
--- a/ec2n.h
+++ b/ec2n.h
@@ -1,8 +1,8 @@
 // ec2n.h - originally written and placed in the public domain by Wei Dai

 

-//! \file

-//! \headerfile ec2n.h

-//! \brief Classes for Elliptic Curves over binary fields

+/// \file

+/// \headerfile ec2n.h

+/// \brief Classes for Elliptic Curves over binary fields

 

 

 #ifndef CRYPTOPP_EC2N_H

@@ -24,8 +24,8 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class EC2N

-//! \brief Elliptic Curve over GF(2^n)

+/// \class EC2N

+/// \brief Elliptic Curve over GF(2^n)

 class CRYPTOPP_DLL EC2N : public AbstractGroup<EC2NPoint>, public EncodedPoint<EC2NPoint>

 {

 public:

@@ -35,23 +35,23 @@ public:
 

 	virtual ~EC2N() {}

 

-	//! \brief Construct an EC2N

+	/// \brief Construct an EC2N

 	EC2N() {}

 

-	//! \brief Construct an EC2N

-	//! \param field Field, GF2NP derived class

-	//! \param a Field::Element

-	//! \param b Field::Element

+	/// \brief Construct an EC2N

+	/// \param field Field, GF2NP derived class

+	/// \param a Field::Element

+	/// \param b Field::Element

 	EC2N(const Field &field, const Field::Element &a, const Field::Element &b)

 		: m_field(field), m_a(a), m_b(b) {}

 

-	//! \brief Construct an EC2N from BER encoded parameters

-	//! \param bt BufferedTransformation derived object

-	//! \details This constructor will decode and extract the the fields fieldID and curve of the sequence ECParameters

+	/// \brief Construct an EC2N from BER encoded parameters

+	/// \param bt BufferedTransformation derived object

+	/// \details This constructor will decode and extract the the fields fieldID and curve of the sequence ECParameters

 	EC2N(BufferedTransformation &bt);

 

-	//! \brief Encode the fields fieldID and curve of the sequence ECParameters

-	//! \param bt BufferedTransformation derived object

+	/// \brief Encode the fields fieldID and curve of the sequence ECParameters

+	/// \param bt BufferedTransformation derived object

 	void DEREncode(BufferedTransformation &bt) const;

 

 	bool Equal(const Point &P, const Point &Q) const;

@@ -97,15 +97,15 @@ private:
 CRYPTOPP_DLL_TEMPLATE_CLASS DL_FixedBasePrecomputationImpl<EC2N::Point>;

 CRYPTOPP_DLL_TEMPLATE_CLASS DL_GroupPrecomputation<EC2N::Point>;

 

-//! \class EcPrecomputation

-//! \brief Elliptic Curve precomputation

-//! \tparam EC elliptic curve field

+/// \class EcPrecomputation

+/// \brief Elliptic Curve precomputation

+/// \tparam EC elliptic curve field

 template <class EC> class EcPrecomputation;

 

-//! \class EcPrecomputation<EC2N>

-//! \brief EC2N precomputation specialization

-//! \details Implementation of <tt>DL_GroupPrecomputation<EC2N::Point></tt>

-//! \sa DL_GroupPrecomputation

+/// \class EcPrecomputation<EC2N>

+/// \brief EC2N precomputation specialization

+/// \details Implementation of <tt>DL_GroupPrecomputation<EC2N::Point></tt>

+/// \sa DL_GroupPrecomputation

 template<> class EcPrecomputation<EC2N> : public DL_GroupPrecomputation<EC2N::Point>

 {

 public: