Updated documentation

1 files changed, 30 insertions, 3 deletions

diff --git a/gzip.h b/gzip.h
index 98d6e26b..8850cf60 100644
--- a/gzip.h
+++ b/gzip.h
@@ -1,3 +1,8 @@
+// gzip.h - written and placed in the public domain by Wei Dai

+

+//! \file gzip.h

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

+

 #ifndef CRYPTOPP_GZIP_H

 #define CRYPTOPP_GZIP_H

 

@@ -8,12 +13,25 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-/// 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.

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

 		: Deflator(attachment, deflateLevel, log2WindowSize, detectUncompressible), m_totalLen(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

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

 		: Deflator(parameters, attachment), m_totalLen(0) {}

 

@@ -35,13 +53,22 @@ class Gunzip : public Inflator
 {

 public:

 	typedef Inflator::Err Err;

+

+	//! \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 : public Err {public: TailErr() : Err(INVALID_DATA_FORMAT, "Gunzip: tail too short") {}};

+	//! \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 : public Err {public: LengthErr() : Err(DATA_INTEGRITY_CHECK_FAILED, "Gunzip: length check error") {}};

 

-	//! \brief Construct a Gunzip

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

+	//! \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 = NULL, bool repeat = false, int autoSignalPropagation = -1);