diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-06-27 22:51:42 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-06-27 22:51:42 +0000 |
commit | 0de3c24ea2b82d1ae8114da19e1075a2e4ea1be7 (patch) | |
tree | 4c1620f806a213906e38c01b9edc3f73659af56a /object.c | |
parent | 4a42dda48262ef31125f76a0a642736281724c33 (diff) | |
download | ruby-0de3c24ea2b82d1ae8114da19e1075a2e4ea1be7.tar.gz |
* 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/trunk@32261 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'object.c')
-rw-r--r-- | object.c | 35 |
1 files changed, 22 insertions, 13 deletions
@@ -2553,23 +2553,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 @@ -2579,6 +2580,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) |