summaryrefslogtreecommitdiff
path: root/object.c
diff options
context:
space:
mode:
authoryugui <yugui@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-08-11 00:38:07 +0000
committeryugui <yugui@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-08-11 00:38:07 +0000
commit745b03fc0e4b765d05e932fff3d6e6b48fe09e25 (patch)
treee50d4620ff829447263fd5b59a9024f9bcf0940f /object.c
parentd4bd0a50618b39ad9eb99187a1e7c6910886b9bc (diff)
merges r32261 from trunk into ruby_1_9_2.
-- * object.c (Init_Object): Teach RDoc what Init_class_hierarchy does to hook up ri for BasicObject, Object, Module and Class. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_2@32914 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'object.c')
-rw-r--r--object.c35
1 files changed, 22 insertions, 13 deletions
diff --git a/object.c b/object.c
index ba180b517e..7ef2c9a8fe 100644
--- a/object.c
+++ b/object.c
@@ -2458,23 +2458,24 @@ rb_f_array(VALUE obj, VALUE arg)
* \ingroup class
*/
-/*
+/* Document-class: BasicObject
+ *
+ * BasicObject is the parent class of all classes in Ruby. It's an explicit
+ * blank class.
+ */
+
+/* Document-class: Object
*
- * <code>BasicObject</code> is the parent class of all classes in Ruby.
- * It's an explicit blank class. <code>Object</code>, the root of Ruby's
- * class hierarchy is a direct subclass of <code>BasicObject</code>. Its
- * methods are therefore available to all objects unless explicitly
- * overridden.
+ * Object is the root of Ruby's class hierarchy. Its methods are available
+ * to all classes unless explicitly overridden.
*
- * <code>Object</code> mixes in the <code>Kernel</code> module, making
- * the built-in kernel functions globally accessible. Although the
- * instance methods of <code>Object</code> are defined by the
- * <code>Kernel</code> module, we have chosen to document them here for
- * clarity.
+ * Object mixes in the Kernel module, making the built-in kernel functions
+ * globally accessible. Although the instance methods of Object are defined
+ * by the Kernel module, we have chosen to document them here for clarity.
*
* In the descriptions of Object's methods, the parameter <i>symbol</i> refers
- * to a symbol, which is either a quoted string or a
- * <code>Symbol</code> (such as <code>:name</code>).
+ * to a symbol, which is either a quoted string or a Symbol (such as
+ * <code>:name</code>).
*/
void
@@ -2485,6 +2486,14 @@ Init_Object(void)
Init_class_hierarchy();
+#if 0
+ // teach RDoc about these classes
+ rb_cBasicObject = rb_define_class("BasicObject", Qnil);
+ rb_cObject = rb_define_class("Object", rb_cBasicObject);
+ rb_cModule = rb_define_class("Module", rb_cObject);
+ rb_cClass = rb_define_class("Class", rb_cModule);
+#endif
+
#undef rb_intern
#define rb_intern(str) rb_intern_const(str)