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

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

1 files changed, 53 insertions, 53 deletions

diff --git a/gzip.h b/gzip.h
index f6b9cac0..93c1f6bb 100644
--- a/gzip.h
+++ b/gzip.h
@@ -1,7 +1,7 @@
 // gzip.h - originally written and placed in the public domain by Wei Dai

 

-//! \file gzip.h

-//! \brief GZIP compression and decompression (RFC 1952)

+/// \file gzip.h

+/// \brief GZIP compression and decompression (RFC 1952)

 

 #ifndef CRYPTOPP_GZIP_H

 #define CRYPTOPP_GZIP_H

@@ -13,47 +13,47 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class Gzip

-//! \brief GZIP Compression (RFC 1952)

+/// \class Gzip

+/// \brief GZIP Compression (RFC 1952)

 class Gzip : public Deflator

 {

 public:

-	//! \brief Construct a Gzip 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 Gzip 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.

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

 		: Deflator(attachment, deflateLevel, log2WindowSize, detectUncompressible), m_totalLen(0), m_filetime(0) { }

 

-	//! \brief Construct a Gzip 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 Gzip compressor

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

+	/// \param attachment an attached transformation

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

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

 		: Deflator(parameters, attachment), m_totalLen(0), m_filetime(0)

 	{

 		IsolatedInitialize(parameters);

 	}

 

-	//! \param filetime the filetime to set in the header. The application is responsible for setting it.

+	/// \param filetime the filetime to set in the header. The application is responsible for setting it.

 	void SetFiletime(word32 filetime) { m_filetime = filetime; }

 

-	//! \param filename the original filename to set in the header. The application is responsible for setting it.

-	//!        RFC 1952 requires a ISO/IEC 8859-1 encoding.

-	//! \param throwOnEncodingError if throwOnEncodingError is true, then the filename is checked to ensure it is

-	//!        ISO/IEC 8859-1 encoded. If the filename does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat

-	//!        is thrown. If throwOnEncodingError is false then the filename is not checked.

+	/// \param filename the original filename to set in the header. The application is responsible for setting it.

+	///        RFC 1952 requires a ISO/IEC 8859-1 encoding.

+	/// \param throwOnEncodingError if throwOnEncodingError is true, then the filename is checked to ensure it is

+	///        ISO/IEC 8859-1 encoded. If the filename does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat

+	///        is thrown. If throwOnEncodingError is false then the filename is not checked.

 	void SetFilename(const std::string& filename, bool throwOnEncodingError = false);

 

-	//! \param comment the comment to set in the header. The application is responsible for setting it.

-	//!        RFC 1952 requires a ISO/IEC 8859-1 encoding.

-	//! \param throwOnEncodingError if throwOnEncodingError is true, then the comment is checked to ensure it is

-	//!        ISO/IEC 8859-1 encoded. If the comment does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat

-	//!        is thrown. If throwOnEncodingError is false then the comment is not checked.

+	/// \param comment the comment to set in the header. The application is responsible for setting it.

+	///        RFC 1952 requires a ISO/IEC 8859-1 encoding.

+	/// \param throwOnEncodingError if throwOnEncodingError is true, then the comment is checked to ensure it is

+	///        ISO/IEC 8859-1 encoded. If the comment does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat

+	///        is thrown. If throwOnEncodingError is false then the comment is not checked.

 	void SetComment(const std::string& comment, bool throwOnEncodingError = false);

 

 	void IsolatedInitialize(const NameValuePairs &parameters);

@@ -77,54 +77,54 @@ protected:
 	std::string m_comment;

 };

 

-//! \class Gunzip

-//! \brief GZIP Decompression (RFC 1952)

+/// \class Gunzip

+/// \brief GZIP Decompression (RFC 1952)

 class Gunzip : public Inflator

 {

 public:

 	typedef Inflator::Err Err;

 

-	//! \class HeaderErr

-	//! \brief Exception thrown when a header decoding error occurs

+	/// \class HeaderErr

+	/// \brief Exception thrown when a header decoding error occurs

 	class HeaderErr : public Err {public: HeaderErr() : Err(INVALID_DATA_FORMAT, "Gunzip: header decoding error") {}};

-	//! \class TailErr

-	//! \brief Exception thrown when the tail is too short

+	/// \class TailErr

+	/// \brief Exception thrown when the tail is too short

 	class TailErr : public Err {public: TailErr() : Err(INVALID_DATA_FORMAT, "Gunzip: tail too short") {}};

-	//! \class CrcErr

-	//! \brief Exception thrown when a CRC error occurs

+	/// \class CrcErr

+	/// \brief Exception thrown when a CRC error occurs

 	class CrcErr : public Err {public: CrcErr() : Err(DATA_INTEGRITY_CHECK_FAILED, "Gunzip: CRC check error") {}};

-	//! \class LengthErr

-	//! \brief Exception thrown when a length error occurs

+	/// \class LengthErr

+	/// \brief Exception thrown when a length error occurs

 	class LengthErr : public Err {public: LengthErr() : Err(DATA_INTEGRITY_CHECK_FAILED, "Gunzip: length check error") {}};

 

-	//! \brief Construct a Gunzip decompressor

-	//! \param attachment an attached transformation

-	//! \param repeat decompress multiple compressed streams in series

-	//! \param autoSignalPropagation 0 to turn off MessageEnd signal

+	/// \brief Construct a Gunzip decompressor

+	/// \param attachment an attached transformation

+	/// \param repeat decompress multiple compressed streams in series

+	/// \param autoSignalPropagation 0 to turn off MessageEnd signal

 	Gunzip(BufferedTransformation *attachment = NULLPTR, bool repeat = false, int autoSignalPropagation = -1);

 

-	//! \return the filetime of the stream as set in the header. The application is responsible for setting it on the decompressed file.

+	/// \return the filetime of the stream as set in the header. The application is responsible for setting it on the decompressed file.

 	word32 GetFiletime() const { return m_filetime; }

 

-	//! \return the filename of the stream as set in the header. The application is responsible for setting it on the decompressed file.

-	//! \param throwOnEncodingError if throwOnEncodingError is true, then the filename is checked to ensure it is

-	//!        ISO/IEC 8859-1 encoded. If the filename does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat is thrown.

-	//!        If throwOnEncodingError is false then the filename is not checked.

+	/// \return the filename of the stream as set in the header. The application is responsible for setting it on the decompressed file.

+	/// \param throwOnEncodingError if throwOnEncodingError is true, then the filename is checked to ensure it is

+	///        ISO/IEC 8859-1 encoded. If the filename does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat is thrown.

+	///        If throwOnEncodingError is false then the filename is not checked.

 	const std::string& GetFilename(bool throwOnEncodingError = false) const;

 

-	//! \return the comment of the stream as set in the header.

-	//! \param throwOnEncodingError if throwOnEncodingError is true, then the comment is checked to ensure it is

-	//!        ISO/IEC 8859-1 encoded. If the comment does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat is thrown.

-	//!        If throwOnEncodingError is false then the comment is not checked.

+	/// \return the comment of the stream as set in the header.

+	/// \param throwOnEncodingError if throwOnEncodingError is true, then the comment is checked to ensure it is

+	///        ISO/IEC 8859-1 encoded. If the comment does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat is thrown.

+	///        If throwOnEncodingError is false then the comment is not checked.

 	const std::string& GetComment(bool throwOnEncodingError = false) const;

 

 protected:

 	enum {

-		//! \brief First header magic value

+		/// \brief First header magic value

 		MAGIC1=0x1f,

-		//! \brief Second header magic value

+		/// \brief Second header magic value

 		MAGIC2=0x8b,

-		//! \brief Deflated flag

+		/// \brief Deflated flag

 		DEFLATED=8

 	};