From 61962b27a51031965cef70451d369b115868fb11 Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Thu, 10 Mar 2011 10:51:38 +0000
Subject: rdoc: 100% documentation coverage!

Of course, RDoc doesn't know quantity vs quality :)
---
 lib/raindrops.rb | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

(limited to 'lib/raindrops.rb')

diff --git a/lib/raindrops.rb b/lib/raindrops.rb
index 88d65f6..54760a6 100644
--- a/lib/raindrops.rb
+++ b/lib/raindrops.rb
@@ -1,9 +1,16 @@
 # -*- encoding: binary -*-
+#
+# Each Raindrops object is a container that holds several counters.
+# It is internally a page-aligned, shared memory area that allows
+# atomic increments, decrements, assignments and reads without any
+# locking.
+#
+#   rd = Raindrops.new 4
+#   rd.incr(0, 1)   -> 1
+#   rd.to_ary       -> [ 1, 0, 0, 0 ]
+#
 class Raindrops
 
-  # Raindrops is currently at version 0.4.1
-  VERSION = '0.4.1'
-
   # Used to represent the number of +active+ and +queued+ sockets for
   # a single listen socket across all threads and processes on a
   # machine.
@@ -18,7 +25,7 @@ class Raindrops
   # +queued+ connections is the number of un-accept()-ed sockets in the
   # queue of a given listen socket.
   #
-  # These stats are currently only available under Linux
+  # These stats are currently only available under \Linux
   class ListenStats < Struct.new(:active, :queued)
 
     # the sum of +active+ and +queued+ sockets
-- 
cgit v1.2.3-24-ge0c7