From 567e6ce5dba5ad2cca2cca8c64123e27939bff2b Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Tue, 26 Oct 2010 21:13:10 +0000
Subject: doc: RDoc updates

Once again we avoid documenting internals on the public
website and use code comments for other developers.
---
 lib/rainbows/fiber/io.rb         | 1 +
 lib/rainbows/fiber/io/compat.rb  | 3 +++
 lib/rainbows/fiber/io/methods.rb | 5 +++++
 3 files changed, 9 insertions(+)

(limited to 'lib/rainbows/fiber')

diff --git a/lib/rainbows/fiber/io.rb b/lib/rainbows/fiber/io.rb
index 711d95e..b8c91c5 100644
--- a/lib/rainbows/fiber/io.rb
+++ b/lib/rainbows/fiber/io.rb
@@ -12,6 +12,7 @@ class Rainbows::Fiber::IO
   attr_accessor :to_io
 
   # :stopdoc:
+  # see Rainbows::Fiber::IO::Compat for initialize implementation
   class << self
     alias :[] :new
   end
diff --git a/lib/rainbows/fiber/io/compat.rb b/lib/rainbows/fiber/io/compat.rb
index 2aaf416..32ec782 100644
--- a/lib/rainbows/fiber/io/compat.rb
+++ b/lib/rainbows/fiber/io/compat.rb
@@ -1,4 +1,7 @@
 # -*- encoding: binary -*-
+# :enddoc:
+#
+# Used to make Rainbows::Fiber::IO behave like 0.97.0 and earlier
 module Rainbows::Fiber::IO::Compat
   def initialize(io, fiber = Fiber.current)
     @to_io, @f = io, fiber
diff --git a/lib/rainbows/fiber/io/methods.rb b/lib/rainbows/fiber/io/methods.rb
index 663fdb4..941a68c 100644
--- a/lib/rainbows/fiber/io/methods.rb
+++ b/lib/rainbows/fiber/io/methods.rb
@@ -1,5 +1,10 @@
 # -*- encoding: binary -*-
+#
+# :enddoc:
 
+# this is used to augment Kgio::Socket and Kgio::Pipe-enhanced classes
+# for use with Rainbows!  Do no use this directly, see
+# Rainbows::Fiber::IO::Pipe and Rainbows::Fiber::IO::Socket instead.
 module Rainbows::Fiber::IO::Methods
   RD = Rainbows::Fiber::RD
   WR = Rainbows::Fiber::WR
-- 
cgit v1.2.3-24-ge0c7