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 | 85b72a85b50d9b03045478b28481ead2fbca205a (patch) | |
| tree | 587da93548000f2019e349bdfcfa3598e5dab503 /ext | |
| parent | 731aa0d0a886bef3fc6a8591e706d7284a4f8cb8 (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/trunk@13947 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext')
| -rw-r--r-- | ext/iconv/iconv.c | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/ext/iconv/iconv.c b/ext/iconv/iconv.c index ccedd0c66d..8fa6be0769 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 @@ -610,7 +610,7 @@ iconv_s_convert(struct iconv_env_t* env) } /* - * Document-method: iconv + * Document-method: Iconv::iconv * call-seq: Iconv.iconv(to, from, *strs) * * Shorthand for |