diff options
author | naruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-01-26 13:31:12 +0000 |
---|---|---|
committer | naruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-01-26 13:31:12 +0000 |
commit | bddadeeae4a5b40461c4f111038015f8c3ca8ada (patch) | |
tree | d4b240a6c2ce3fade3d08b92165d72c4ef2f7b75 /ext/zlib/zlib.c | |
parent | 05d80e2fc68675be7339a7b5a909c90680ed23bc (diff) | |
download | ruby-bddadeeae4a5b40461c4f111038015f8c3ca8ada.tar.gz |
* ext/zlib/zlib.c (rb_gzfile_s_wrap): add rdoc. [Bug #2656]
patched by Hugh Sasse [ruby-core:27692] [ruby-core:27852]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@26429 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/zlib/zlib.c')
-rw-r--r-- | ext/zlib/zlib.c | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/ext/zlib/zlib.c b/ext/zlib/zlib.c index bdc0a5eadc..cfe6dd23cb 100644 --- a/ext/zlib/zlib.c +++ b/ext/zlib/zlib.c @@ -2420,12 +2420,14 @@ gzfile_ensure_close(VALUE obj) } /* - * Creates a GzipFile object associated with ((|io|)), and + * call-seq: Zlib::GzipFile.wrap(io) { |gz| ... } + * + * Creates a GzipFile object associated with +io+, and * executes the block with the newly created GzipFile object, * just like File.open. The GzipFile object will be closed * automatically after executing the block. If you want to keep * the associated IO object opening, you may call - * ((<Zlib::GzipFile#finish>)) method in the block. + * +Zlib::GzipFile#finish+ method in the block. */ static VALUE rb_gzfile_s_wrap(int argc, VALUE *argv, VALUE klass) |