summaryrefslogtreecommitdiff
path: root/object.c
diff options
context:
space:
mode:
authordave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-01-02 06:01:12 +0000
committerdave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-01-02 06:01:12 +0000
commit62cbbfb24be234c3d520630cba2b0ee119db43a6 (patch)
treec389921b2db0f0622c37ac351b61ce7b48bdaeef /object.c
parent76aec3b5295183786fb2274e4e7105806f406f67 (diff)
Finish documenting internal stuff. See Changelog for other details
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@5364 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'object.c')
-rw-r--r--object.c55
1 files changed, 31 insertions, 24 deletions
diff --git a/object.c b/object.c
index 90b7697..26d3ea3 100644
--- a/object.c
+++ b/object.c
@@ -1171,7 +1171,7 @@ sym_to_sym(sym)
/***********************************************************************
*
- * Document-class: Module
+ * Document-class: Module
*
* A <code>Module</code> is a collection of methods and constants. The
* methods in a module may be instance methods or module methods.
@@ -1197,6 +1197,15 @@ sym_to_sym(sym)
*
*/
+/*
+ * call-seq:
+ * mod.to_s => string
+ *
+ * Return a string representing this module or class. For basic
+ * classes and modules, this is the name. For singletons, we
+ * show information on the thing we're attached to as well.
+ */
+
static VALUE
rb_mod_to_s(klass)
VALUE klass;
@@ -2395,30 +2404,28 @@ VALUE ruby_top_self;
*
* Creating a new Name
*
- * Classes, modules, and objects are interrelated. In the diagram
- * that follows, the arrows represent inheritance, and the
- * parentheses meta-classes. All metaclasses are instances
- * of the class `Class'.
- *
- * +------------------+
- * | |
- * Object---->(Object) |
- * ^ ^ ^ ^ |
- * | | | | |
- * | | +-----+ +---------+ |
- * | | | | |
- * | +-----------+ | |
- * | | | | |
- * +------+ | Module--->(Module) |
- * | | ^ ^ |
- * OtherClass-->(OtherClass) | | |
- * | | |
- * Class---->(Class) |
- * ^ |
- * | |
- * +----------------+
- *
+ * Classes, modules, and objects are interrelated. In the diagram
+ * that follows, the arrows represent inheritance, and the
+ * parentheses meta-classes. All metaclasses are instances
+ * of the class `Class'.
*
+ * +------------------+
+ * | |
+ * Object---->(Object) |
+ * ^ ^ ^ ^ |
+ * | | | | |
+ * | | +-----+ +---------+ |
+ * | | | | |
+ * | +-----------+ | |
+ * | | | | |
+ * +------+ | Module--->(Module) |
+ * | | ^ ^ |
+ * OtherClass-->(OtherClass) | | |
+ * | | |
+ * Class---->(Class) |
+ * ^ |
+ * | |
+ * +----------------+
*/