* object.c (rb_obj_equal): Add documentation. Patch by Vincent Batts.

	  [Ruby 1.9 - Bug #4664]
	* lib/rexml:  ditto
	* lib/mkmf.rb:  ditto
	* ext/socket/lib/socket.rb:  ditto


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31525 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 13 insertions, 4 deletions

diff --git a/object.c b/object.c
index fad726cd73..f4a28fd259 100644
--- a/object.c
+++ b/object.c
@@ -97,6 +97,15 @@ rb_obj_equal(VALUE obj1, VALUE obj2)
     return Qfalse;
 }
 
+/* 
+ * Generates a <code>Fixnum</code> hash value for this object. This function must have the
+ * property that a.eql?(b) implies a.hash <code>==</code> b.hash. 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.
+ *
+ * 	"waffle"	#=> "waffle"
+ * 	"waffle".hash	#=> -910576647
+ */
 VALUE
 rb_obj_hash(VALUE obj)
 {
@@ -1774,10 +1783,10 @@ rb_mod_const_defined(int argc, VALUE *argv, VALUE mod)
     return RTEST(recur) ? rb_const_defined(mod, id) : rb_const_defined_at(mod, id);
 }
 
-VALUE rb_obj_methods(int argc, VALUE *argv, VALUE obj);
-VALUE rb_obj_protected_methods(int argc, VALUE *argv, VALUE obj);
-VALUE rb_obj_private_methods(int argc, VALUE *argv, VALUE obj);
-VALUE rb_obj_public_methods(int argc, VALUE *argv, VALUE obj);
+VALUE rb_obj_methods(int argc, VALUE *argv, VALUE obj); /* in class.c */
+VALUE rb_obj_protected_methods(int argc, VALUE *argv, VALUE obj); /* in class.c */
+VALUE rb_obj_private_methods(int argc, VALUE *argv, VALUE obj); /* in class.c */
+VALUE rb_obj_public_methods(int argc, VALUE *argv, VALUE obj); /* in class.c */
 
 /*
  *  call-seq: