From d3b97d1114e2d23a9231fe889cd5bf6927d451ba Mon Sep 17 00:00:00 2001 From: Eric Wong 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/rev/client.rb | 1 + lib/rainbows/rev/core.rb | 1 + lib/rainbows/rev/deferred_response.rb | 1 + lib/rainbows/rev/heartbeat.rb | 1 + lib/rainbows/rev/master.rb | 1 + lib/rainbows/rev/sendfile.rb | 1 + lib/rainbows/rev/thread.rb | 1 + 7 files changed, 7 insertions(+) (limited to 'lib/rainbows/rev') diff --git a/lib/rainbows/rev/client.rb b/lib/rainbows/rev/client.rb index 91947b6..d08992b 100644 --- a/lib/rainbows/rev/client.rb +++ b/lib/rainbows/rev/client.rb @@ -1,4 +1,5 @@ # -*- encoding: binary -*- +# :enddoc: require 'rainbows/ev_core' module Rainbows module Rev diff --git a/lib/rainbows/rev/core.rb b/lib/rainbows/rev/core.rb index 4668cce..9f7a1f0 100644 --- a/lib/rainbows/rev/core.rb +++ b/lib/rainbows/rev/core.rb @@ -1,4 +1,5 @@ # -*- encoding: binary -*- +# :enddoc: require 'rev' Rev::VERSION >= '0.3.0' or abort 'rev >= 0.3.0 is required' require 'rainbows/rev/heartbeat' diff --git a/lib/rainbows/rev/deferred_response.rb b/lib/rainbows/rev/deferred_response.rb index f710b5b..de348bb 100644 --- a/lib/rainbows/rev/deferred_response.rb +++ b/lib/rainbows/rev/deferred_response.rb @@ -1,4 +1,5 @@ # -*- encoding: binary -*- +# :enddoc: module Rainbows module Rev diff --git a/lib/rainbows/rev/heartbeat.rb b/lib/rainbows/rev/heartbeat.rb index 54cc056..da1a1e2 100644 --- a/lib/rainbows/rev/heartbeat.rb +++ b/lib/rainbows/rev/heartbeat.rb @@ -1,4 +1,5 @@ # -*- encoding: binary -*- +# :enddoc: module Rainbows module Rev diff --git a/lib/rainbows/rev/master.rb b/lib/rainbows/rev/master.rb index 01282f5..40615ac 100644 --- a/lib/rainbows/rev/master.rb +++ b/lib/rainbows/rev/master.rb @@ -1,4 +1,5 @@ # -*- encoding: binary -*- +# :enddoc: require 'rainbows/rev' module Rainbows diff --git a/lib/rainbows/rev/sendfile.rb b/lib/rainbows/rev/sendfile.rb index ae0b116..414cfa1 100644 --- a/lib/rainbows/rev/sendfile.rb +++ b/lib/rainbows/rev/sendfile.rb @@ -1,4 +1,5 @@ # -*- encoding: binary -*- +# :enddoc: module Rainbows::Rev::Sendfile if IO.method_defined?(:sendfile_nonblock) F = Rainbows::StreamFile diff --git a/lib/rainbows/rev/thread.rb b/lib/rainbows/rev/thread.rb index ba80bb1..8fc7172 100644 --- a/lib/rainbows/rev/thread.rb +++ b/lib/rainbows/rev/thread.rb @@ -1,4 +1,5 @@ # -*- encoding: binary -*- +# :enddoc: require 'thread' require 'rainbows/rev/master' -- cgit v1.2.3-24-ge0c7