doc: RDoc updates

Once again we avoid documenting internals on the public
website and use code comments for other developers.

5 files changed, 13 insertions, 0 deletions

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
diff --git a/lib/rainbows/writer_thread_pool.rb b/lib/rainbows/writer_thread_pool.rb
index a8ffd7d..a81725a 100644
--- a/lib/rainbows/writer_thread_pool.rb
+++ b/lib/rainbows/writer_thread_pool.rb
@@ -20,6 +20,7 @@ module Rainbows
   # slow client denial-of-service attacks.
 
   module WriterThreadPool
+    # :stopdoc:
     include Base
 
     # used to wrap a BasicSocket to use with +q+ for all writes
@@ -95,5 +96,6 @@ module Rainbows
       super(worker) # accept loop from Unicorn
       qp.map { |q| q.quit! }
     end
+    # :startdoc:
   end
 end
diff --git a/lib/rainbows/writer_thread_spawn.rb b/lib/rainbows/writer_thread_spawn.rb
index c190f89..691e68c 100644
--- a/lib/rainbows/writer_thread_spawn.rb
+++ b/lib/rainbows/writer_thread_spawn.rb
@@ -21,6 +21,7 @@ module Rainbows
   # vulnerable to slow client denial-of-service attacks.
 
   module WriterThreadSpawn
+    # :stopdoc:
     include Base
 
     CUR = {} # :nodoc:
@@ -115,5 +116,6 @@ module Rainbows
         t.alive? ? t.join(0.01) : true
       end until CUR.empty?
     end
+    # :startdoc:
   end
 end