basis/compression/zlib/zlib-docs.factor

   1 ! Copyright (C) 2013 Benjamin Pollack.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: byte-arrays help.markup help.syntax ;
   4 IN: compression.zlib
   5
   6 HELP: compress
   7 { $values
   8     { "byte-array" byte-array }
   9     { "byte-array'" byte-array }
  10 }
  11 { $description "Returns a byte-array of compressed bytes." } ;
  12
  13 HELP: uncompress
  14 { $values
  15     { "byte-array" byte-array }
  16     { "byte-array'" byte-array }
  17 }
  18 { $description "Takes a zlib-compressed byte-array and uncompresses it to another byte-array." } ;
  19
  20 ARTICLE: "compression.zlib" "Compression (ZLIB)"
  21 "The " { $vocab-link "compression.zlib" } " vocabulary provides support for ZLIB:"
  22 { $subsections
  23     compress
  24     uncompress
  25 } ;
  26
  27 ABOUT: "compression.zlib"