From d3b97d1114e2d23a9231fe889cd5bf6927d451ba Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Sat, 10 Jul 2010 08:04:48 +0000
Subject: doc: avoid documenting internals on RDoc website

Since we suck at building websites, we just rely on RDoc as a
website builder.  And since Rainbows! is an application server
(and not a programming library), our internal API should be of
little interest to end users.

Anybody interested in Rainbows! (or any other project) internals
should be reading the source.
---
 lib/rainbows/event_machine.rb | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

(limited to 'lib/rainbows/event_machine.rb')

diff --git a/lib/rainbows/event_machine.rb b/lib/rainbows/event_machine.rb
index bbb38fa..173340e 100644
--- a/lib/rainbows/event_machine.rb
+++ b/lib/rainbows/event_machine.rb
@@ -48,7 +48,7 @@ module Rainbows
 
     include Base
 
-    class Client < EM::Connection
+    class Client < EM::Connection # :nodoc: all
       include Rainbows::EvCore
       include Rainbows::Response
       G = Rainbows::G
@@ -149,7 +149,7 @@ module Rainbows
       end
     end
 
-    module ResponsePipe
+    module ResponsePipe # :nodoc: all
       def initialize(client)
         @client = client
       end
@@ -160,7 +160,7 @@ module Rainbows
       end
     end
 
-    module ResponseChunkPipe
+    module ResponseChunkPipe # :nodoc: all
       include ResponsePipe
 
       def unbind
@@ -187,7 +187,7 @@ module Rainbows
       end
     end
 
-    module Server
+    module Server # :nodoc: all
 
       def close
         detach
@@ -205,7 +205,7 @@ module Rainbows
     # Middleware that will run the app dispatch in a separate thread.
     # This middleware is automatically loaded by Rainbows! when using
     # EventMachine and if the app responds to the +deferred?+ method.
-    class TryDefer < Struct.new(:app)
+    class TryDefer < Struct.new(:app) # :nodoc: all
 
       def initialize(app)
         # the entire app becomes multithreaded, even the root (non-deferred)
@@ -226,7 +226,7 @@ module Rainbows
       end
     end
 
-    def init_worker_process(worker)
+    def init_worker_process(worker) # :nodoc:
       Rainbows::Response.setup(Rainbows::EventMachine::Client)
       super
     end
@@ -234,7 +234,7 @@ module Rainbows
     # runs inside each forked worker, this sits around and waits
     # for connections and doesn't die until the parent dies (or is
     # given a INT, QUIT, or TERM signal)
-    def worker_loop(worker)
+    def worker_loop(worker) # :nodoc:
       init_worker_process(worker)
       G.server.app.respond_to?(:deferred?) and
         G.server.app = TryDefer[G.server.app]
-- 
cgit v1.2.3-24-ge0c7