trunk/branch integration: documentation

This commit is contained in:
Marian Krivos 2011-08-23 06:51:23 +00:00
parent 7f54dc2b35
commit 1e58e9e2a0

View File

@ -1,7 +1,7 @@
//
// InflatingStream.h
//
// $Id: //poco/svn/Foundation/include/Poco/InflatingStream.h#2 $
// $Id: //poco/1.4/Foundation/include/Poco/InflatingStream.h#2 $
//
// Library: Foundation
// Package: Streams
@ -44,7 +44,11 @@
#include "Poco/BufferedStreamBuf.h"
#include <istream>
#include <ostream>
#if defined(POCO_UNBUNDLED)
#include <zlib.h>
#else
#include "Poco/zlib.h"
#endif
namespace Poco {
@ -52,7 +56,7 @@ namespace Poco {
class Foundation_API InflatingStreamBuf: public BufferedStreamBuf
/// This is the streambuf class used by InflatingInputStream and InflatingOutputStream.
/// The actual work is delegated to zlib 1.2.1 (see http://www.gzip.org).
/// The actual work is delegated to zlib (see http://zlib.net).
/// Both zlib (deflate) streams and gzip streams are supported.
/// Output streams should always call close() to ensure
/// proper completion of decompression.
@ -60,9 +64,9 @@ class Foundation_API InflatingStreamBuf: public BufferedStreamBuf
public:
enum StreamType
{
STREAM_ZLIB,
STREAM_GZIP,
STREAM_ZIP // ZIP is handled as STREAM_ZLIB, except that we do not check the ADLER32 value (must be checked by an outside class!)
STREAM_ZLIB, /// Expect a zlib header, use Adler-32 checksum.
STREAM_GZIP, /// Expect a gzip header, use CRC-32 checksum.
STREAM_ZIP /// STREAM_ZIP is handled as STREAM_ZLIB, except that we do not check the ADLER32 value (must be checked by caller)
};
InflatingStreamBuf(std::istream& istr, StreamType type);