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

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

1 files changed, 14 insertions, 14 deletions

diff --git a/hex.h b/hex.h
index 008a6dbb..ba6ee98f 100644
--- a/hex.h
+++ b/hex.h
@@ -1,7 +1,7 @@
 // hex.h - originally written and placed in the public domain by Wei Dai

 

-//! \file hex.h

-//! \brief Classes for HexEncoder and HexDecoder

+/// \file hex.h

+/// \brief Classes for HexEncoder and HexDecoder

 

 #ifndef CRYPTOPP_HEX_H

 #define CRYPTOPP_HEX_H

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

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class HexEncoder

-//! \brief Converts given data to base 16

+/// \class HexEncoder

+/// \brief Converts given data to base 16

 class CRYPTOPP_DLL HexEncoder : public SimpleProxyFilter

 {

 public:

-	//! \brief Construct a HexEncoder

-	//! \param attachment a BufferedTrasformation to attach to this object

-	//! \param uppercase a flag indicating uppercase output

-	//! \param groupSize the size of the output grouping

-	//! \param separator the separator to use between groups

-	//! \param terminator the terminator append after processing

+	/// \brief Construct a HexEncoder

+	/// \param attachment a BufferedTrasformation to attach to this object

+	/// \param uppercase a flag indicating uppercase output

+	/// \param groupSize the size of the output grouping

+	/// \param separator the separator to use between groups

+	/// \param terminator the terminator append after processing

 	HexEncoder(BufferedTransformation *attachment = NULLPTR, bool uppercase = true, int groupSize = 0, const std::string &separator = ":", const std::string &terminator = "")

 		: SimpleProxyFilter(new BaseN_Encoder(new Grouper), attachment)

 	{

@@ -31,13 +31,13 @@ public:
 	void IsolatedInitialize(const NameValuePairs &parameters);

 };

 

-//! \class HexDecoder

-//! \brief Decode base 16 data back to bytes

+/// \class HexDecoder

+/// \brief Decode base 16 data back to bytes

 class CRYPTOPP_DLL HexDecoder : public BaseN_Decoder

 {

 public:

-	//! \brief Construct a HexDecoder

-	//! \param attachment a BufferedTrasformation to attach to this object

+	/// \brief Construct a HexDecoder

+	/// \param attachment a BufferedTrasformation to attach to this object

 	HexDecoder(BufferedTransformation *attachment = NULLPTR)

 		: BaseN_Decoder(GetDefaultDecodingLookupArray(), 4, attachment) {}