From ed79783bb2996a1941b3ccb9bf98e1ddf5ceba4b Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Thu, 22 Jan 1998 16:11:18 +0000 Subject: Converted to use new macros. This example demonstrate \method{} and, more importantly, \url{}. --- Doc/lib/libzlib.tex | 33 +++++++++++++++++---------------- Doc/libzlib.tex | 33 +++++++++++++++++---------------- 2 files changed, 34 insertions(+), 32 deletions(-) diff --git a/Doc/lib/libzlib.tex b/Doc/lib/libzlib.tex index 7d2cac9..cca3501 100644 --- a/Doc/lib/libzlib.tex +++ b/Doc/lib/libzlib.tex @@ -7,7 +7,7 @@ For applications that require data compression, the functions in this module allow compression and decompression, using the zlib library, which is based on GNU zip. The zlib library has its own home page at -\code{http://www.cdrom.com/pub/infozip/zlib/}. +\url{http://www.cdrom.com/pub/infozip/zlib/}. Version 1.0.4 is the most recent version as of December, 1997; use a later version if one is available. @@ -27,18 +27,19 @@ The available functions in this module are: \begin{funcdesc}{compress}{string\optional{\, level}} Compresses the data in \var{string}, returning a string contained -compressed data. \var{level} is an integer from 1 to 9 controlling -the level of compression; 1 is fastest and produces the least -compression, 9 is slowest and produces the most. The default value is -6. Raises the \code{zlib.error} exception if any error occurs. +compressed data. \var{level} is an integer from \code{1} to \code{9} +controlling the level of compression; \code{1} is fastest and produces +the least compression, \code{9} is slowest and produces the most. The +default value is \code{6}. Raises the \exception{zlib.error} +exception if any error occurs. \end{funcdesc} \begin{funcdesc}{compressobj}{\optional{level}} -Returns a compression object, to be used for compressing data streams + Returns a compression object, to be used for compressing data streams that won't fit into memory at once. \var{level} is an integer from - 1 to 9 controlling the level of compression; 1 is fastest and - produces the least compression, 9 is slowest and produces the most. - The default value is 6. + \code{1} to \code{9} controlling the level of compression; \code{1} is + fastest and produces the least compression, \code{9} is slowest and + produces the most. The default value is \code{6}. \end{funcdesc} \begin{funcdesc}{crc32}{string\optional{\, value}} @@ -52,7 +53,7 @@ Returns a compression object, to be used for compressing data streams \begin{funcdesc}{decompress}{string} Decompresses the data in \var{string}, returning a string containing -the uncompressed data. Raises the \code{zlib.error} exception if any +the uncompressed data. Raises the \exception{zlib.error} exception if any error occurs. \end{funcdesc} @@ -69,14 +70,14 @@ Compression objects support the following methods: Compress \var{string}, returning a string containing compressed data for at least part of the data in \var{string}. This data should be concatenated to the output produced by any preceding calls to the -\code{compress()} method. Some input may be kept in internal buffers +\method{compress()} method. Some input may be kept in internal buffers for later processing. \end{funcdesc} \begin{funcdesc}{flush}{} All pending input is processed, and an string containing the remaining -compressed output is returned. After calling \code{flush()}, the -\code{compress()} method cannot be called again; the only realistic +compressed output is returned. After calling \method{flush()}, the +\method{compress()} method cannot be called again; the only realistic action is to delete the object. \end{funcdesc} @@ -87,14 +88,14 @@ Decompress \var{string}, returning a string containing the uncompressed data corresponding to at least part of the data in \var{string}. This data should be concatenated to the output produced by any preceding calls to the -\code{decompress()} method. Some of the input data may be preserved +\method{decompress()} method. Some of the input data may be preserved in internal buffers for later processing. \end{funcdesc} \begin{funcdesc}{flush}{} All pending input is processed, and a string containing the remaining -uncompressed output is returned. After calling \code{flush()}, the -\code{decompress()} method cannot be called again; the only realistic +uncompressed output is returned. After calling \method{flush()}, the +\method{decompress()} method cannot be called again; the only realistic action is to delete the object. \end{funcdesc} diff --git a/Doc/libzlib.tex b/Doc/libzlib.tex index 7d2cac9..cca3501 100644 --- a/Doc/libzlib.tex +++ b/Doc/libzlib.tex @@ -7,7 +7,7 @@ For applications that require data compression, the functions in this module allow compression and decompression, using the zlib library, which is based on GNU zip. The zlib library has its own home page at -\code{http://www.cdrom.com/pub/infozip/zlib/}. +\url{http://www.cdrom.com/pub/infozip/zlib/}. Version 1.0.4 is the most recent version as of December, 1997; use a later version if one is available. @@ -27,18 +27,19 @@ The available functions in this module are: \begin{funcdesc}{compress}{string\optional{\, level}} Compresses the data in \var{string}, returning a string contained -compressed data. \var{level} is an integer from 1 to 9 controlling -the level of compression; 1 is fastest and produces the least -compression, 9 is slowest and produces the most. The default value is -6. Raises the \code{zlib.error} exception if any error occurs. +compressed data. \var{level} is an integer from \code{1} to \code{9} +controlling the level of compression; \code{1} is fastest and produces +the least compression, \code{9} is slowest and produces the most. The +default value is \code{6}. Raises the \exception{zlib.error} +exception if any error occurs. \end{funcdesc} \begin{funcdesc}{compressobj}{\optional{level}} -Returns a compression object, to be used for compressing data streams + Returns a compression object, to be used for compressing data streams that won't fit into memory at once. \var{level} is an integer from - 1 to 9 controlling the level of compression; 1 is fastest and - produces the least compression, 9 is slowest and produces the most. - The default value is 6. + \code{1} to \code{9} controlling the level of compression; \code{1} is + fastest and produces the least compression, \code{9} is slowest and + produces the most. The default value is \code{6}. \end{funcdesc} \begin{funcdesc}{crc32}{string\optional{\, value}} @@ -52,7 +53,7 @@ Returns a compression object, to be used for compressing data streams \begin{funcdesc}{decompress}{string} Decompresses the data in \var{string}, returning a string containing -the uncompressed data. Raises the \code{zlib.error} exception if any +the uncompressed data. Raises the \exception{zlib.error} exception if any error occurs. \end{funcdesc} @@ -69,14 +70,14 @@ Compression objects support the following methods: Compress \var{string}, returning a string containing compressed data for at least part of the data in \var{string}. This data should be concatenated to the output produced by any preceding calls to the -\code{compress()} method. Some input may be kept in internal buffers +\method{compress()} method. Some input may be kept in internal buffers for later processing. \end{funcdesc} \begin{funcdesc}{flush}{} All pending input is processed, and an string containing the remaining -compressed output is returned. After calling \code{flush()}, the -\code{compress()} method cannot be called again; the only realistic +compressed output is returned. After calling \method{flush()}, the +\method{compress()} method cannot be called again; the only realistic action is to delete the object. \end{funcdesc} @@ -87,14 +88,14 @@ Decompress \var{string}, returning a string containing the uncompressed data corresponding to at least part of the data in \var{string}. This data should be concatenated to the output produced by any preceding calls to the -\code{decompress()} method. Some of the input data may be preserved +\method{decompress()} method. Some of the input data may be preserved in internal buffers for later processing. \end{funcdesc} \begin{funcdesc}{flush}{} All pending input is processed, and a string containing the remaining -uncompressed output is returned. After calling \code{flush()}, the -\code{decompress()} method cannot be called again; the only realistic +uncompressed output is returned. After calling \method{flush()}, the +\method{decompress()} method cannot be called again; the only realistic action is to delete the object. \end{funcdesc} -- cgit v0.12