From ff42f8f4854525bfecb1a76252730aaad137080f Mon Sep 17 00:00:00 2001
From: Yukihiro Matsumoto <matz@ruby-lang.org>
Date: Thu, 5 Jul 2012 22:56:51 +0900
Subject: move RDoc comments

---
 src/kernel.c | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)

(limited to 'src/kernel.c')

diff --git a/src/kernel.c b/src/kernel.c
index 605b84124..d230305da 100644
--- a/src/kernel.c
+++ b/src/kernel.c
@@ -207,14 +207,19 @@ mrb_equal_m(mrb_state *mrb, mrb_value self)
 /* 15.3.1.3.3  */
 /* 15.3.1.3.33 */
 /*
+ *  Document-method: __id__
+ *  Document-method: object_id
+ *
  *  call-seq:
- *     obj.hash    -> fixnum
+ *     obj.__id__       -> fixnum
+ *     obj.object_id    -> fixnum
  *
- *  Generates a <code>Fixnum</code> hash value for this object. This
- *  function must have the property that <code>a.eql?(b)</code> implies
- *  <code>a.hash == b.hash</code>. The hash value is used by class
- *  <code>Hash</code>. Any hash value that exceeds the capacity of a
- *  <code>Fixnum</code> will be truncated before being used.
+ *  Returns an integer identifier for <i>obj</i>. The same number will
+ *  be returned on all calls to <code>id</code> for a given object, and
+ *  no two active objects will share an id.
+ *  <code>Object#object_id</code> is a different concept from the
+ *  <code>:name</code> notation, which returns the symbol id of
+ *  <code>name</code>. Replaces the deprecated <code>Object#id</code>.
  */
 static mrb_value
 mrb_obj_id_m(mrb_state *mrb, mrb_value self)
@@ -526,6 +531,16 @@ mrb_obj_extend_m(mrb_state *mrb, mrb_value self)
 //mrb_f_global_variables(mrb_state *mrb, mrb_value self)
 
 /* 15.3.1.3.15 */
+/*
+ *  call-seq:
+ *     obj.hash    -> fixnum
+ *
+ *  Generates a <code>Fixnum</code> hash value for this object. This
+ *  function must have the property that <code>a.eql?(b)</code> implies
+ *  <code>a.hash == b.hash</code>. The hash value is used by class
+ *  <code>Hash</code>. Any hash value that exceeds the capacity of a
+ *  <code>Fixnum</code> will be truncated before being used.
+ */
 mrb_value
 mrb_obj_hash(mrb_state *mrb, mrb_value self)
 {
-- 
cgit v1.2.3