* gc.c (WeakMap): Add doc for internal reference, use lib/weakref.rb

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

ChangeLog

@@ -1,3 +1,7 @@
+Sun Dec  2 16:45:00 2012  Zachary Scott  <zachary@zacharyscott.net>
+
+	* gc.c (WeakMap): Add doc for internal reference, use lib/weakref.rb
+
 Sun Dec  2 07:24:23 2012  Eric Hodel  <drbrain@segment7.net>
 
 	* lib/rdoc/parser.rb:  Parse files with a -*- rdoc -*- modeline

gc.c

@@ -4412,7 +4412,10 @@ rb_gcdebug_sentinel(VALUE obj, const char *name)
  *  Document-class: ObjectSpace::WeakMap
  *
  *  An ObjectSpace::WeakMap object holds references to
- *  any objects, but those objects can get disposed by GC.
+ *  any objects, but those objects can get be garbage collected.
+ *
+ *  This class is mostly used internally by WeakRef, please use
+ *  +lib/weakref.rb+ for the public interface.
  */
 
 /*  Document-class: GC::Profiler