trunk/branch integration: documentation

This commit is contained in:
Marian Krivos
2011-08-23 06:41:50 +00:00
parent 4cc807d67d
commit 2f88a6f971

View File

@@ -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 DeflatingStreamBuf: public BufferedStreamBuf
/// This is the streambuf class used by DeflatingInputStream and DeflatingOutputStream.
/// 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 compression.
@@ -61,8 +65,8 @@ class Foundation_API DeflatingStreamBuf: public BufferedStreamBuf
public:
enum StreamType
{
STREAM_ZLIB,
STREAM_GZIP
STREAM_ZLIB, /// Create a zlib header, use Adler-32 checksum.
STREAM_GZIP /// Create a gzip header, use CRC-32 checksum.
};
DeflatingStreamBuf(std::istream& istr, StreamType type, int level);