minor doc updates

Author: pitr-ch

lib/concurrent/edge/atomic_markable_reference.rb

@@ -6,9 +6,8 @@ module Edge
     #   An atomic reference which maintains an object reference along with a mark bit
     #   that can be updated atomically.
     #
-    #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicMarkableReference.html java.util.concurrent.atomic.AtomicMarkableReference
-    #
-    #   @api Edge
+    #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicMarkableReference.html
+    #     java.util.concurrent.atomic.AtomicMarkableReference
     class AtomicMarkableReference < ::Concurrent::Synchronization::Object
 
       private(*attr_atomic(:reference))

lib/concurrent/edge/cancellation.rb

@@ -1,14 +1,15 @@
 module Concurrent
 
   # Provides tools for cooperative cancellation.
-  # Inspired by https://msdn.microsoft.com/en-us/library/dd537607(v=vs.110).aspx
+  # Inspired by <https://msdn.microsoft.com/en-us/library/dd537607(v=vs.110).aspx>
+  #
   # @example
   #   # Create new cancellation. `cancellation` is used for cancelling, `token` is passed down to
   #   # tasks for cooperative cancellation
   #   cancellation, token = Concurrent::Cancellation.create
   #   Thread.new(token) do |token|
-  #     # Count 1+1 (simulating some other meaningful work) repeatedly until the token is cancelled through
-  #     # cancellation.
+  #     # Count 1+1 (simulating some other meaningful work) repeatedly
+  #     # until the token is cancelled through cancellation.
   #     token.loop_until_canceled { 1+1 }
   #   end
   #   sleep 0.1

lib/concurrent/edge/lock_free_queue.rb

@@ -1,5 +1,6 @@
 module Concurrent
 
+  # @!visibility private
   class LockFreeQueue < Synchronization::Object
 
     class Node < Synchronization::Object

lib/concurrent/synchronization/condition.rb

@@ -1,9 +1,12 @@
 module Concurrent
   module Synchronization
+    # TODO (pitr-ch 04-Dec-2016): should be in edge
     class Condition < LockableObject
       safe_initialization!
 
       # TODO (pitr 12-Sep-2015): locks two objects, improve
+      # TODO (pitr 26-Sep-2015): study
+      # http://grepcode.com/file/repository.grepcode.com/java/root/jdk/openjdk/8-b132/java/util/concurrent/locks/AbstractQueuedSynchronizer.java#AbstractQueuedSynchronizer.Node
 
       singleton_class.send :alias_method, :private_new, :new
       private_class_method :new

lib/concurrent/synchronization/lock.rb

@@ -1,5 +1,6 @@
 module Concurrent
   module Synchronization
+    # TODO (pitr-ch 04-Dec-2016): should be in edge
     class Lock < LockableObject
       # TODO use JavaReentrantLock on JRuby
 

lib/concurrent/synchronization/object.rb

@@ -22,6 +22,7 @@ module Synchronization
     # - volatile instance variables see {Object.attr_volatile}
     # - volatile instance variables see {Object.attr_atomic}
     class Object < ObjectImplementation
+      # TODO make it a module if possible
 
       # @!method self.attr_volatile(*names)
       #   Creates methods for reading and writing (as `attr_accessor` does) to a instance variable with