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

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

1 files changed, 47 insertions, 47 deletions

diff --git a/zdeflate.h b/zdeflate.h
index e9c51b1c..8b1d5cb6 100644
--- a/zdeflate.h
+++ b/zdeflate.h
@@ -1,7 +1,7 @@
 // zdeflate.h - originally written and placed in the public domain by Wei Dai

 

-//! \file zdeflate.h

-//! \brief DEFLATE compression and decompression (RFC 1951)

+/// \file zdeflate.h

+/// \brief DEFLATE compression and decompression (RFC 1951)

 

 #ifndef CRYPTOPP_ZDEFLATE_H

 #define CRYPTOPP_ZDEFLATE_H

@@ -12,14 +12,14 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class LowFirstBitWriter

-//! \brief Encoding table writer

-//! \since Crypto++ 1.0

+/// \class LowFirstBitWriter

+/// \brief Encoding table writer

+/// \since Crypto++ 1.0

 class LowFirstBitWriter : public Filter

 {

 public:

-	//! \brief Construct a LowFirstBitWriter

-	//! \param attachment an attached transformation

+	/// \brief Construct a LowFirstBitWriter

+	/// \param attachment an attached transformation

 	LowFirstBitWriter(BufferedTransformation *attachment);

 

 	void PutBits(unsigned long value, unsigned int length);

@@ -37,26 +37,26 @@ protected:
 	FixedSizeSecBlock<byte, 256> m_outputBuffer;

 };

 

-//! \class HuffmanEncoder

-//! \brief Huffman Encoder

-//! \since Crypto++ 1.0

+/// \class HuffmanEncoder

+/// \brief Huffman Encoder

+/// \since Crypto++ 1.0

 class HuffmanEncoder

 {

 public:

 	typedef unsigned int code_t;

 	typedef unsigned int value_t;

 

-	//! \brief Construct a HuffmanEncoder

+	/// \brief Construct a HuffmanEncoder

 	HuffmanEncoder() {}

 

-	//! \brief Construct a HuffmanEncoder

-	//! \param codeBits a table of code bits

-	//! \param nCodes the number of codes in the table

+	/// \brief Construct a HuffmanEncoder

+	/// \param codeBits a table of code bits

+	/// \param nCodes the number of codes in the table

 	HuffmanEncoder(const unsigned int *codeBits, unsigned int nCodes);

 

-	//! \brief Initialize or reinitialize this object

-	//! \param codeBits a table of code bits

-	//! \param nCodes the number of codes in the table

+	/// \brief Initialize or reinitialize this object

+	/// \param codeBits a table of code bits

+	/// \param nCodes the number of codes in the table

 	void Initialize(const unsigned int *codeBits, unsigned int nCodes);

 

 	static void GenerateCodeLengths(unsigned int *codeBits, unsigned int maxCodeBits, const unsigned int *codeCounts, size_t nCodes);

@@ -72,56 +72,56 @@ public:
 	SecBlock<Code> m_valueToCode;

 };

 

-//! \class Deflator

-//! \brief DEFLATE compressor (RFC 1951)

-//! \since Crypto++ 1.0

+/// \class Deflator

+/// \brief DEFLATE compressor (RFC 1951)

+/// \since Crypto++ 1.0

 class Deflator : public LowFirstBitWriter

 {

 public:

-	//! \brief Deflate level as enumerated values.

+	/// \brief Deflate level as enumerated values.

 	enum {

-		//! \brief Minimum deflation level, fastest speed (0)

+		/// \brief Minimum deflation level, fastest speed (0)

 		MIN_DEFLATE_LEVEL = 0,

-		//! \brief Default deflation level, compromise between speed (6)

+		/// \brief Default deflation level, compromise between speed (6)

 		DEFAULT_DEFLATE_LEVEL = 6,

-		//! \brief Minimum deflation level, slowest speed (9)

+		/// \brief Minimum deflation level, slowest speed (9)

 		MAX_DEFLATE_LEVEL = 9};

 

-	//! \brief Windows size as enumerated values.

+	/// \brief Windows size as enumerated values.

 	enum {

-		//! \brief Minimum window size, smallest table (9)

+		/// \brief Minimum window size, smallest table (9)

 		MIN_LOG2_WINDOW_SIZE = 9,

-		//! \brief Default window size (15)

+		/// \brief Default window size (15)

 		DEFAULT_LOG2_WINDOW_SIZE = 15,

-		//! \brief Maximum window size, largest table (15)

+		/// \brief Maximum window size, largest table (15)

 		MAX_LOG2_WINDOW_SIZE = 15};

 

-	//! \brief Construct a Deflator compressor

-	//! \param attachment an attached transformation

-	//! \param deflateLevel the deflate level

-	//! \param log2WindowSize the window size

-	//! \param detectUncompressible flag to detect if data is compressible

-	//! \details detectUncompressible makes it faster to process uncompressible files, but

-	//!   if a file has both compressible and uncompressible parts, it may fail to compress

-	//!   some of the compressible parts.

+	/// \brief Construct a Deflator compressor

+	/// \param attachment an attached transformation

+	/// \param deflateLevel the deflate level

+	/// \param log2WindowSize the window size

+	/// \param detectUncompressible flag to detect if data is compressible

+	/// \details detectUncompressible makes it faster to process uncompressible files, but

+	///   if a file has both compressible and uncompressible parts, it may fail to compress

+	///   some of the compressible parts.

 	Deflator(BufferedTransformation *attachment=NULLPTR, int deflateLevel=DEFAULT_DEFLATE_LEVEL, int log2WindowSize=DEFAULT_LOG2_WINDOW_SIZE, bool detectUncompressible=true);

-	//! \brief Construct a Deflator compressor

-	//! \param parameters a set of NameValuePairs to initialize this object

-	//! \param attachment an attached transformation

-	//! \details Possible parameter names: Log2WindowSize, DeflateLevel, DetectUncompressible

+	/// \brief Construct a Deflator compressor

+	/// \param parameters a set of NameValuePairs to initialize this object

+	/// \param attachment an attached transformation

+	/// \details Possible parameter names: Log2WindowSize, DeflateLevel, DetectUncompressible

 	Deflator(const NameValuePairs &parameters, BufferedTransformation *attachment=NULLPTR);

 

-	//! \brief Sets the deflation level

-	//! \param deflateLevel the level of deflation

-	//! \details SetDeflateLevel can be used to set the deflate level in the middle of compression

+	/// \brief Sets the deflation level

+	/// \param deflateLevel the level of deflation

+	/// \details SetDeflateLevel can be used to set the deflate level in the middle of compression

 	void SetDeflateLevel(int deflateLevel);

 

-	//! \brief Retrieves the deflation level

-	//! \returns the level of deflation

+	/// \brief Retrieves the deflation level

+	/// \returns the level of deflation

 	int GetDeflateLevel() const {return m_deflateLevel;}

 

-	//! \brief Retrieves the window size

-	//! \returns the windows size

+	/// \brief Retrieves the window size

+	/// \returns the windows size

 	int GetLog2WindowSize() const {return m_log2WindowSize;}

 

 	void IsolatedInitialize(const NameValuePairs &parameters);