From 1f3e7b1c7ee89aefdcadd4aebd7b0527baa188a3 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 11 Jun 2011 05:46:52 +0000 Subject: doc: remove docs for Rainbows::Fiber::* APIs Do not encourage their use, really. --- lib/rainbows/fiber.rb | 5 +---- lib/rainbows/fiber/io.rb | 2 +- lib/rainbows/fiber/io/methods.rb | 1 - lib/rainbows/fiber/io/pipe.rb | 2 ++ lib/rainbows/fiber/io/socket.rb | 2 ++ 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/rainbows/fiber.rb b/lib/rainbows/fiber.rb index 34b7c39..a0f3f99 100644 --- a/lib/rainbows/fiber.rb +++ b/lib/rainbows/fiber.rb @@ -1,11 +1,10 @@ # -*- encoding: binary -*- -# :stopdoc: +# :enddoc: begin require 'fiber' rescue LoadError defined?(NeverBlock) or raise end -# :startdoc: # core namespace for all things that use Fibers in \Rainbows! # @@ -15,7 +14,6 @@ end # supporting these in the future. module Rainbows::Fiber - # :stopdoc: # blocked readers (key: fileno, value: Rainbows::Fiber::IO object) RD = [] @@ -24,7 +22,6 @@ module Rainbows::Fiber # sleeping fibers go here (key: Fiber object, value: wakeup time) ZZ = {} - # :startdoc: # puts the current Fiber into uninterruptible sleep for at least # +seconds+. Unlike Kernel#sleep, this it is not possible to sleep diff --git a/lib/rainbows/fiber/io.rb b/lib/rainbows/fiber/io.rb index 0eed4ad..b121854 100644 --- a/lib/rainbows/fiber/io.rb +++ b/lib/rainbows/fiber/io.rb @@ -1,5 +1,5 @@ # -*- encoding: binary -*- - +# :enddoc: # A \Fiber-aware IO class, gives users the illusion of a synchronous # interface that yields away from the current \Fiber whenever # the underlying descriptor is blocked on reads or write diff --git a/lib/rainbows/fiber/io/methods.rb b/lib/rainbows/fiber/io/methods.rb index 29ee397..9df0f01 100644 --- a/lib/rainbows/fiber/io/methods.rb +++ b/lib/rainbows/fiber/io/methods.rb @@ -1,5 +1,4 @@ # -*- encoding: binary -*- -# # :enddoc: # this is used to augment Kgio::Socket and Kgio::Pipe-enhanced classes diff --git a/lib/rainbows/fiber/io/pipe.rb b/lib/rainbows/fiber/io/pipe.rb index 59114d7..bb9b4be 100644 --- a/lib/rainbows/fiber/io/pipe.rb +++ b/lib/rainbows/fiber/io/pipe.rb @@ -1,4 +1,6 @@ # -*- encoding: binary -*- +# :enddoc: +# # A Fiber-aware Pipe class, gives users the illusion of a synchronous # interface that yields away from the current Fiber whenever # the underlying descriptor is blocked on reads or write. diff --git a/lib/rainbows/fiber/io/socket.rb b/lib/rainbows/fiber/io/socket.rb index 2b4df12..c074d35 100644 --- a/lib/rainbows/fiber/io/socket.rb +++ b/lib/rainbows/fiber/io/socket.rb @@ -1,4 +1,6 @@ # -*- encoding: binary -*- +# :enddoc: +# # A Fiber-aware Socket class, gives users the illusion of a synchronous # interface that yields away from the current Fiber whenever # the underlying descriptor is blocked on reads or write. -- cgit v1.2.3-24-ge0c7