Add documentation for Module#included

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

2 files changed, 32 insertions, 3 deletions

diff --git a/ChangeLog b/ChangeLog
index e98760354d..4b689b8c23 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 85241f907b..87ce20b3de 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()