Marked private API abstractions.

Author: jdantonio

lib/concurrent/agent.rb

@@ -91,7 +91,15 @@ class Agent
     #
     # @param [Object] initial the initial value
     #
-    # @!macro executor_and_deref_options
+    # @!macro [attach] executor_and_deref_options
+    #  
+    #   @param [Hash] opts the options used to define the behavior at update and deref
+    #     and to specify the executor on which to perform actions
+    #   @option opts [Executor] :executor when set use the given `Executor` instance.
+    #     Three special values are also supported: `:task` returns the global task pool,
+    #     `:operation` returns the global operation pool, and `:immediate` returns a new
+    #     `ImmediateExecutor` object.
+    #   @!macro deref_options
     def initialize(initial, opts = {})
       @value                = initial
       @rescuers             = []

lib/concurrent/atomic/atomic_boolean.rb

@@ -22,6 +22,8 @@ module Concurrent
   #         3.340000   0.010000   3.350000 (  0.855000)
   #
   #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicBoolean.html java.util.concurrent.atomic.AtomicBoolean
+  #
+  # @api private
   class MutexAtomicBoolean < Synchronization::Object
 
     # @!macro [attach] atomic_boolean_method_initialize
@@ -105,6 +107,7 @@ def ns_make_value(value)
     end
   end
 
+  # @api private
   AtomicBooleanImplementation = case
                                 when Concurrent.on_jruby?
                                   JavaAtomicBoolean

lib/concurrent/atomic/atomic_fixnum.rb

@@ -22,6 +22,8 @@ module Concurrent
   #         4.520000   0.030000   4.550000 (  1.187000)
   #
   #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicLong.html java.util.concurrent.atomic.AtomicLong
+  #
+  # @api private
   class MutexAtomicFixnum < Synchronization::Object
 
     # http://stackoverflow.com/questions/535721/ruby-max-integer
@@ -132,6 +134,7 @@ def range_check!(value)
     end
   end
 
+  # @api private
   AtomicFixnumImplementation = case
                                when Concurrent.on_jruby?
                                  JavaAtomicFixnum

lib/concurrent/atomic/count_down_latch.rb

@@ -11,6 +11,8 @@ module Concurrent
   #   method. Each of the other threads calls `#count_down` when done with its work.
   #   When the latch counter reaches zero the waiting thread is unblocked and continues
   #   with its work. A `CountDownLatch` can be used only once. Its value cannot be reset.
+  #
+  # @api private
   class PureCountDownLatch < Synchronization::Object
 
     # @!macro [attach] count_down_latch_method_initialize
@@ -69,6 +71,7 @@ def ns_initialize(count)
   if Concurrent.on_jruby?
 
     # @!macro count_down_latch
+    # @api private
     class JavaCountDownLatch
 
       # @!macro count_down_latch_method_initialize

lib/concurrent/atomic/cyclic_barrier.rb

@@ -4,6 +4,7 @@ module Concurrent
 
   class CyclicBarrier < Synchronization::Object
 
+    # @api private
     Generation = Struct.new(:status)
     private_constant :Generation
 

lib/concurrent/atomic/thread_local_var.rb

@@ -34,6 +34,7 @@ module Concurrent
   #   @see https://docs.oracle.com/javase/7/docs/api/java/lang/ThreadLocal.html Java ThreadLocal
   class AbstractThreadLocalVar
 
+    # @api private
     NIL_SENTINEL = Object.new
     private_constant :NIL_SENTINEL
 

lib/concurrent/atomic/thread_local_var/weak_key_map.rb

@@ -21,6 +21,7 @@
 
 module Concurrent
 
+  # @api private
   class AbstractThreadLocalVar
 
     begin

lib/concurrent/atomic_reference/direct_update.rb

@@ -3,6 +3,7 @@
 module Concurrent
 
   # Define update methods that use direct paths
+  # @api private
   module AtomicDirectUpdate
 
     # @!macro [attach] atomic_reference_method_update

lib/concurrent/atomic_reference/jruby.rb

@@ -6,6 +6,7 @@
   module Concurrent
 
     # @!macro atomic_reference
+    # @api private
     class JavaAtomicReference
       include Concurrent::AtomicDirectUpdate
     end

lib/concurrent/atomic_reference/mutex_atomic.rb

@@ -5,6 +5,7 @@
 module Concurrent
 
   # @!macro atomic_reference
+  # @api private
   class MutexAtomicReference
     include Concurrent::AtomicDirectUpdate
     include Concurrent::AtomicNumericCompareAndSetWrapper