clones/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2024-10-01 15:27:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

compress/zlib: add example to doc comment

Browse Source 
Fixes #548.

R=r
CC=golang-dev, graycardinalster
https://golang.org/cl/190062
This commit is contained in:
Russ Cox 2010-01-19 13:09:50 -08:00
parent ae3e8eb2ec
commit 14ccf44fc7
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/pkg/compress/zlib/reader.go
View File

@ -2,8 +2,25 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// The zlib package implements reading and writing of zlib
// format compressed files, as specified in RFC 1950.
/*
The zlib package implements reading and writing of zlib
format compressed data, as specified in RFC 1950.
The implementation provides filters that uncompress during reading
and compress during writing. For example, to write compressed data
to a buffer:
var b bytes.Buffer
w, err := zlib.NewDeflater(&b)
w.Write(strings.Bytes("hello, world\n"))
w.Close()
and to read that data back:
r, err := zlib.NewInflater(&b)
io.Copy(os.Stdout, r)
r.Close()
*/
package zlib
import (