From 32d17e265c84973516d1717868806b324ba3052a Mon Sep 17 00:00:00 2001
From: knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 7 May 2001 23:38:52 +0000
Subject: Initial revision

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@1375 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 doc/forwardable.rd | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 doc/forwardable.rd

(limited to 'doc/forwardable.rd')

diff --git a/doc/forwardable.rd b/doc/forwardable.rd
new file mode 100644
index 0000000000..54a4d83de9
--- /dev/null
+++ b/doc/forwardable.rd
@@ -0,0 +1,84 @@
+ -- forwardable.rb
+						
+                                                $Release Version: 1.1 $
+                                                $Revision$
+                                                $Date$
+						Original version by Tosh
+
+==begin
+
+= Forwardable
+
+A Module to define delegations for selected methods to a class.
+
+== Usage
+
+Using through extending the class.
+  
+  class Foo
+    extend Forwardable
+
+    def_delegators("@out", "printf", "print")
+    def_delegators(:@in, :gets)
+    def_delegator(:@contents, :[], "content_at")
+  end
+  f = Foo.new
+  f.printf ...
+  f.gets
+  f.content_at(1)
+
+== Methods
+
+--- Forwardable#def_instance_delegators(accessor, *methods)
+
+      adding the delegations for each method of ((|methods|)) to
+      ((|accessor|)).
+
+--- Forwardable#def_instance_delegator(accessor, method, ali = method)
+      
+      adding the delegation for ((|method|)) to ((|accessor|)). When
+      you give optional argument ((|ali|)), ((|ali|)) is used as the
+      name of the delegation method, instead of ((|method|)).
+
+--- Forwardable#def_delegators(accessor, *methods)
+
+      the alias of ((|Forwardable#def_instance_delegators|)).
+
+--- Forwardable#def_delegator(accessor, method, ali = method)
+      
+      the alias of ((|Forwardable#def_instance_delegator|)).
+
+= SingleForwardable
+
+a Module to define delegations for selected methods to an object.
+
+== Usage
+
+Using through extending the object.
+
+  g = Goo.new
+  g.extend SingleForwardable
+  g.def_delegator("@out", :puts)
+  g.puts ...
+
+== Methods
+
+--- SingleForwardable#def_singleton_delegators(accessor, *methods)
+
+      adding the delegations for each method of ((|methods|)) to
+      ((|accessor|)).
+
+--- SingleForwardable#def_singleton_delegator(accessor, method, ali = method)
+
+      adding the delegation for ((|method|)) to ((|accessor|)). When
+      you give optional argument ((|ali|)), ((|ali|)) is used as the
+      name of the delegation method, instead of ((|method|)).
+
+--- SingleForwardable#def_delegators(accessor, *methods)
+
+      the alias of ((|SingleForwardable#def_instance_delegators|)).
+
+--- SingleForwardable#def_delegator(accessor, method, ali = method)
+
+      the alias of ((|SingleForwardable#def_instance_delegator|)).
+==end
\ No newline at end of file
-- 
cgit v1.2.3