pike.git/ src/ modules/ Gz/ zlibmod.c

Branch: Tag:

2001-11-18

2001-11-18 02:00:22 by Martin Nilsson <mani@lysator.liu.se>

Added som documentation from the doc directory.

Rev: src/modules/Gz/zlibmod.c:1.42

5:   \*/   /**/   #include "global.h" - RCSID("$Id: zlibmod.c,v 1.41 2001/07/05 01:47:20 hubbe Exp $"); + RCSID("$Id: zlibmod.c,v 1.42 2001/11/18 02:00:22 nilsson Exp $");      #include "zlib_machine.h"   
70:      /*! @class deflate    *! +  *! Gz_deflate is a builtin program written in C. It interfaces the +  *! packing routines in the libz library. +  *! +  *! @note +  *! This program is only available if libz was available and found when +  *! Pike was compiled. +  *!    *! @seealso    *! @[Gz.inflate()]    */
290:   /*******************************************************************/      /*! @class inflate +  *! +  *! Gz_deflate is a builtin program written in C. It interfaces the +  *! unpacking routines in the libz library. +  *! +  *! @note +  *! This program is only available if libz was available and found when +  *! Pike was compiled. +  *! +  *! @seealso +  *! @[deflate]    */      /*! @decl void create()
395:    *! This function performs gzip style decompression. It can inflate    *! a whole file at once or in blocks.    *! +  *! @example +  *! // whole file +  *! write(Gz_inflate()->inflate(stdin->read(0x7fffffff)); +  *! +  *! // streaming (blocks) +  *! function inflate=Gz_inflate()->inflate; +  *! while(string s=stdin->read(8192)) +  *! write(inflate(s)); +  *!    *! @seealso    *! @[Gz.deflate->deflate()]    */