diff options
author | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-11-16 08:03:36 +0000 |
---|---|---|
committer | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-11-16 08:03:36 +0000 |
commit | 994bd271c06c11aeb04528a688726bd60d6ea261 (patch) | |
tree | 8c5b9a005d227c9c7af161d475c5b61d11963795 | |
parent | d8d2fe124a997668edcfe24bc312d77138939d86 (diff) |
* ext/iconv/iconv.c (Document-class): moved the simplest example to
the top.
* ext/iconv/iconv.c (iconv_s_iconv): Document-method: needs class
prefix for class method. [ruby-core:13542]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@13947 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r-- | ChangeLog | 8 | ||||
-rw-r--r-- | ext/iconv/iconv.c | 16 |
2 files changed, 16 insertions, 8 deletions
@@ -1,3 +1,11 @@ +Fri Nov 16 17:03:34 2007 Nobuyoshi Nakada <nobu@ruby-lang.org> + + * ext/iconv/iconv.c (Document-class): moved the simplest example to + the top. + + * ext/iconv/iconv.c (iconv_s_iconv): Document-method: needs class + prefix for class method. [ruby-core:13542] + Fri Nov 16 11:16:41 2007 Nobuyoshi Nakada <nobu@ruby-lang.org> * lib/yaml/rubytypes.rb (String#is_binary_data?): use Integer#fdiv. diff --git a/ext/iconv/iconv.c b/ext/iconv/iconv.c index 65fed33bd2..7f9918e28b 100644 --- a/ext/iconv/iconv.c +++ b/ext/iconv/iconv.c @@ -43,7 +43,11 @@ * * == Examples * - * 1. Instantiate a new Iconv and use method Iconv#iconv. + * 1. Simple conversion between two charsets. + * + * converted_text = Iconv.conv('iso-8859-15', 'utf-8', text) + * + * 2. Instantiate a new Iconv and use method Iconv#iconv. * * cd = Iconv.new(to, from) * begin @@ -53,20 +57,16 @@ * cd.close * end * - * 2. Invoke Iconv.open with a block. + * 3. Invoke Iconv.open with a block. * * Iconv.open(to, from) do |cd| * input.each { |s| output << cd.iconv(s) } * output << cd.iconv(nil) * end * - * 3. Shorthand for (2). + * 4. Shorthand for (3). * * Iconv.iconv(to, from, *input.to_a) - * - * 4. Simple conversion between two charsets. - * - * converted_text = Iconv.new('iso-8859-15', 'utf-8').iconv(text) */ /* Invalid value for iconv_t is -1 but 0 for VALUE, I hope VALUE is @@ -606,7 +606,7 @@ iconv_s_convert } /* - * Document-method: iconv + * Document-method: Iconv::iconv * call-seq: Iconv.iconv(to, from, *strs) * * Shorthand for |