* 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

ChangeLog

@@ -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 16:26:57 2007  Shugo Maeda  <shugo@ruby-lang.org>
 
 	* include/ruby/ruby.h: added some declarations for event hooks.

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