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/fiber/base.rb  | 1 +
 lib/rainbows/fiber/body.rb  | 1 +
 lib/rainbows/fiber/io.rb    | 1 -
 lib/rainbows/fiber/queue.rb | 1 +
 lib/rainbows/fiber/rev.rb   | 1 +
 5 files changed, 4 insertions(+), 1 deletion(-)

(limited to 'lib/rainbows/fiber')

diff --git a/lib/rainbows/fiber/base.rb b/lib/rainbows/fiber/base.rb
index 9ac3b72..b3a4c89 100644
--- a/lib/rainbows/fiber/base.rb
+++ b/lib/rainbows/fiber/base.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# :enddoc:
 require 'rainbows/fiber/io'
 
 module Rainbows
diff --git a/lib/rainbows/fiber/body.rb b/lib/rainbows/fiber/body.rb
index 3de45ee..ab5cfc8 100644
--- a/lib/rainbows/fiber/body.rb
+++ b/lib/rainbows/fiber/body.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# :enddoc:
 # non-portable body handling for Fiber-based concurrency goes here
 # this module is required and included in worker processes only
 # this is meant to be included _after_ Rainbows::Response::Body
diff --git a/lib/rainbows/fiber/io.rb b/lib/rainbows/fiber/io.rb
index f6b8bdf..596aeae 100644
--- a/lib/rainbows/fiber/io.rb
+++ b/lib/rainbows/fiber/io.rb
@@ -21,7 +21,6 @@ module Rainbows
       def peeraddr
         to_io.respond_to?(:peeraddr) ? to_io.peeraddr : [ LOCALHOST ]
       end
-      # :stopdoc:
 
       # for wrapping output response bodies
       def each(&block)
diff --git a/lib/rainbows/fiber/queue.rb b/lib/rainbows/fiber/queue.rb
index 384fe2b..e7118f3 100644
--- a/lib/rainbows/fiber/queue.rb
+++ b/lib/rainbows/fiber/queue.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# :enddoc:
 module Rainbows
   module Fiber
 
diff --git a/lib/rainbows/fiber/rev.rb b/lib/rainbows/fiber/rev.rb
index a1ffe33..1babad3 100644
--- a/lib/rainbows/fiber/rev.rb
+++ b/lib/rainbows/fiber/rev.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# :enddoc:
 require 'rev'
 require 'rainbows/fiber'
 require 'rainbows/fiber/io'
-- 
cgit v1.2.3-24-ge0c7