summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-08-30 14:23:19 +0000
committerdave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-08-30 14:23:19 +0000
commitf7b90183903672bc8fc77aaa676a34aa6f6a9e07 (patch)
tree8d9baa054d3f889b4e7c1e521dc6bac824c6362c
parent8e94bb29ae5c33d988cba29f130ba0d0a7276b00 (diff)
Add documentation for Module#included
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@6839 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--ChangeLog4
-rw-r--r--object.c31
2 files changed, 32 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index e98760354d4..4b689b8c23a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Mon Aug 30 21:50:14 2004 Dave Thomas <dave@pragprog.com>
+
+ * object.c: Add RDoc for Module.included.
+
Mon Aug 30 23:11:06 2004 Dave Thomas <dave@pragprog.com>
* lib/rdoc/ri/ri_driver.rb (and others): ri now merges documentation
diff --git a/object.c b/object.c
index 85241f907ba..87ce20b3deb 100644
--- a/object.c
+++ b/object.c
@@ -503,7 +503,7 @@ rb_obj_is_kind_of(obj, c)
/*
- * Document-method: singleton-method-added
+ * Document-method: singleton_method_added
*
* call-seq:
* singleton_method_added(symbol)
@@ -529,7 +529,7 @@ rb_obj_is_kind_of(obj, c)
*/
/*
- * Document-method: singleton-method-removed
+ * Document-method: singleton_method_removed
*
* call-seq:
* singleton_method_removed(symbol)
@@ -557,7 +557,7 @@ rb_obj_is_kind_of(obj, c)
*/
/*
- * Document-method: singleton-method-undefined
+ * Document-method: singleton_method_undefined
*
* call-seq:
* singleton_method_undefined(symbol)
@@ -581,6 +581,31 @@ rb_obj_is_kind_of(obj, c)
*/
+/*
+ * Document-method: included
+ *
+ * call-seq:
+ * included( othermod )
+ *
+ * Callback invoked whenever the receiver is included in another
+ * module or class. This should be used in preference to
+ * <tt>Module.append_features</tt> if your code wants to perform some
+ * action when a module is included in another.
+ *
+ * module A
+ * def A.included(mod)
+ * puts "#{self} included in #{mod}"
+ * end
+ * end
+ * module Enumerable
+ * include A
+ * end
+ */
+
+
+/*
+ * Not documented
+ */
static VALUE
rb_obj_dummy()