added YARD to ring buffer and blocking ring buffer

Author: mighe

lib/concurrent/channel/blocking_ring_buffer.rb

@@ -11,30 +11,38 @@ def initialize(capacity)
       @condition = Condition.new
     end
 
+    # @return [Integer] the capacity of the buffer
     def capacity
       @mutex.synchronize { @buffer.capacity }
     end
 
+    # @return [Integer] the number of elements currently in the buffer
     def count
       @mutex.synchronize { @buffer.count }
     end
 
-    def full?
-      @mutex.synchronize { @buffer.full? }
-    end
-
+    # @return [Boolean] true if buffer is empty, false otherwise
     def empty?
       @mutex.synchronize { @buffer.empty? }
     end
 
+    # @return [Boolean] true if buffer is full, false otherwise
+    def full?
+      @mutex.synchronize { @buffer.full? }
+    end
+
+    # @param [Object] value. This methods blocks until an empty slot is available
+    # @return [Boolean] true if value has been inserted, false otherwise
     def put(value)
       @mutex.synchronize do
         wait_while_full
         @buffer.offer(value)
         @condition.signal
+        true
       end
     end
 
+    # @return [Object] the first available value and removes it from the buffer. If buffer is empty it blocks until an element is available
     def take
       @mutex.synchronize do
         wait_while_empty
@@ -44,6 +52,7 @@ def take
       end
     end
 
+    # @return [Object] the first available value and without removing it from the buffer. If buffer is empty returns nil
     def peek
       @mutex.synchronize { @buffer.peek }
     end

lib/concurrent/channel/ring_buffer.rb

@@ -1,6 +1,6 @@
 module Concurrent
 
-  # not thread safe buffer
+  # non-thread safe buffer
   class RingBuffer
 
     def initialize(capacity)
@@ -9,18 +9,23 @@ def initialize(capacity)
       @count = 0
     end
 
+
+    # @return [Integer] the capacity of the buffer
     def capacity
       @buffer.size
     end
 
+    # @return [Integer] the number of elements currently in the buffer
     def count
       @count
     end
 
+    # @return [Boolean] true if buffer is empty, false otherwise
     def empty?
       @count == 0
     end
 
+    # @return [Boolean] true if buffer is full, false otherwise
     def full?
       @count == capacity
     end