Fix YARD documentation

Author: pitr-ch

CHANGELOG.md

@@ -4,36 +4,36 @@ concurrent-ruby:
 
 * [Promises](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Promises.html)
   are moved from `concurrent-ruby-edge` to `concurrent-ruby`
-* #644 Fix Map#each and #each_pair not returning enumerator outside of MRI
-* #659 Edge promises fail during error handling
-* #741 Raise on recursive Delay#value call
-* #727 #717 fix global IO executor on JRuby
-* #740 Drop support for CRuby 1.9, JRuby 1.7, Rubinius.
-* #737 Move AtomicMarkableReference out of Edge
-* #708 Prefer platform specific memory barriers 
+* (#644) Fix Map#each and #each_pair not returning enumerator outside of MRI
+* (#659) Edge promises fail during error handling
+* (#741) Raise on recursive Delay#value call
+* (#727) #717 fix global IO executor on JRuby
+* (#740) Drop support for CRuby 1.9, JRuby 1.7, Rubinius.
+* (#737) Move AtomicMarkableReference out of Edge
+* (#708) Prefer platform specific memory barriers 
 * Add support for TruffleRuby
-  * #734 Fix Array/Hash/Set construction broken on TruffleRuby    
-* #735 Fix wrong expected exception in channel spec assertion
+  * (#734) Fix Array/Hash/Set construction broken on TruffleRuby    
+* (#735) Fix wrong expected exception in channel spec assertion
 * CI stabilization
-* #729 Allow executor option in `Promise#then`
-* #725 fix timeout check to use timeout_interval
-* #719 update engine detection
-* #660 Add specs for Promise#zip/Promise.zip ordering
-* #654 Promise.zip execution changes
-* #666 Add thread safe set implementation
-* #651 #699 #to_s, #inspect should not output negative object IDs.
-* #685 Avoid RSpec warnings about raise_error
-* #680 Avoid RSpec monkey patching, persist spec results locally, use RSpec
+* (#729) Allow executor option in `Promise#then`
+* (#725) fix timeout check to use timeout_interval
+* (#719) update engine detection
+* (#660) Add specs for Promise#zip/Promise.zip ordering
+* (#654) Promise.zip execution changes
+* (#666) Add thread safe set implementation
+* (#651) #699 #to_s, #inspect should not output negative object IDs.
+* (#685) Avoid RSpec warnings about raise_error
+* (#680) Avoid RSpec monkey patching, persist spec results locally, use RSpec
   v3.7.0
-* #665 Initialize the monitor for new subarrays on Rubinius
-* #661 Fix error handling in edge promises
+* (#665) Initialize the monitor for new subarrays on Rubinius
+* (#661) Fix error handling in edge promises
 * remove sharp dependency edge -> core
 * remove warnings
 * documentation updates
 
 concurrent-ruby-edge:
 
-* #659 Edge promises fail during error handling
+* (#659) Edge promises fail during error handling
 * Edge files clearly separated in `lib-edge`
 * added ReInclude
 

Gemfile

@@ -13,7 +13,7 @@ group :development do
   gem 'rake', '~> 12.0'
   gem 'rake-compiler', '~> 1.0'
   gem 'rake-compiler-dock', '~> 0.6.0'
-  gem 'pry', '~> 0.11'
+  gem 'pry', '~> 0.11', platforms: :mri
 end
 
 group :documentation, optional: true do

README.md

@@ -323,13 +323,13 @@ best practice is to depend on `concurrent-ruby` and let users to decide if they
 *   [Jerry D'Antonio](https://github.com/jdantonio) (creator)
 *   [Chris Seaton](https://github.com/chrisseaton)
 
-### Special Thanks
+### Special Thanks to
 
 *   [Brian Durand](https://github.com/bdurand) for the `ref` gem
 *   [Charles Oliver Nutter](https://github.com/headius) for the `atomic` and `thread_safe` gems
 *   [thedarkone](https://github.com/thedarkone) for the `thread_safe` gem
 
-### Maintainers of the past
+and to the past maintainers
 
 *   [Michele Della Torre](https://github.com/mighe)
 *   [Paweł Obrok](https://github.com/obrok)

Rakefile

@@ -66,7 +66,7 @@ begin
     desc '- test packaged and installed gems instead of local files'
     task :installed => :repackage do
       sh 'gem install pkg/concurrent-ruby-1.1.0.pre1.gem'
-      sh 'gem install pkg/concurrent-ruby-ext-1.1.0.pre1.gem'
+      sh 'gem install pkg/concurrent-ruby-ext-1.1.0.pre1.gem' if Concurrent.on_cruby?
       sh 'gem install pkg/concurrent-ruby-edge-0.4.0.pre1.gem'
       ENV['NO_PATH'] = 'true'
       sh 'bundle install'

concurrent-ruby-ext.gemspec

@@ -17,11 +17,6 @@ Gem::Specification.new do |s|
   EOF
 
   s.files            = Dir['ext/**/*.{h,c,cpp}']
-  s.files           += [
-    'lib/concurrent/atomic_reference/concurrent_update_error.rb',
-    'lib/concurrent/atomic_reference/direct_update.rb',
-    'lib/concurrent/atomic_reference/numeric_cas_wrapper.rb',
-  ]
   s.extra_rdoc_files = Dir['README*', 'LICENSE*', 'CHANGELOG*']
   s.require_paths    = ['lib']
   s.extensions       = 'ext/concurrent-ruby-ext/extconf.rb'

doc/promises-main.md

@@ -41,8 +41,7 @@ This framework allows its users to:
     pressure (parts, which are not keeping up, signal to the other parts of the 
     system to slow down).
 
-**The guide is best place to start with promises, see**
-**{file:doc/promises.out.md}.**
+**The {file:doc/promises.out.md guide} is best place to start with promises.**
 
 # Main classes
 

lib-edge/concurrent/channel/buffer/base.rb

@@ -15,13 +15,13 @@ module Buffer
       # used as a channel buffer should extend this class.
       class Base < Synchronization::LockableObject
 
-        # @!macro [attach] channel_buffer_capacity_reader
+        # @!macro channel_buffer_capacity_reader
         #
         #   The maximum number of values which can be {#put} onto the buffer
         #   it becomes full.
         attr_reader :capacity
 
-        # @!macro [attach] channel_buffer_initialize
+        # @!macro channel_buffer_initialize
         #
         #   Creates a new buffer.
         def initialize(*args)
@@ -35,7 +35,7 @@ def initialize(*args)
           end
         end
 
-        # @!macro [attach] channel_buffer_blocking_question
+        # @!macro channel_buffer_blocking_question
         #
         #   Predicate indicating if this buffer will block {#put} operations
         #   once it reaches its maximum capacity.
@@ -45,14 +45,14 @@ def blocking?
           true
         end
 
-        # @!macro [attach] channel_buffer_size_reader
+        # @!macro channel_buffer_size_reader
         #
         #   The number of items currently in the buffer.
         def size
           synchronize { ns_size }
         end
 
-        # @!macro [attach] channel_buffer_empty_question
+        # @!macro channel_buffer_empty_question
         #
         #   Predicate indicating if the buffer is empty.
         #
@@ -63,7 +63,7 @@ def empty?
           synchronize { ns_empty? }
         end
 
-        # @!macro [attach] channel_buffer_full_question
+        # @!macro channel_buffer_full_question
         #
         #   Predicate indicating if the buffer is full.
         #
@@ -74,7 +74,7 @@ def full?
           synchronize { ns_full? }
         end
 
-        # @!macro [attach] channel_buffer_put
+        # @!macro channel_buffer_put
         #
         #   Put an item onto the buffer if possible. If the buffer is open
         #   but not able to accept the item the calling thread will block
@@ -89,7 +89,7 @@ def put(item)
           raise NotImplementedError
         end
 
-        # @!macro [attach] channel_buffer_offer
+        # @!macro channel_buffer_offer
         #
         #   Put an item onto the buffer if possible. If the buffer is open but
         #   unable to add an item, probably due to being full, the method will
@@ -107,7 +107,7 @@ def offer(item)
           raise NotImplementedError
         end
 
-        # @!macro [attach] channel_buffer_take
+        # @!macro channel_buffer_take
         #
         #   Take an item from the buffer if one is available. If the buffer
         #   is open and no item is available the calling thread will block
@@ -123,7 +123,7 @@ def take
           raise NotImplementedError
         end
 
-        # @!macro [attach] channel_buffer_next
+        # @!macro channel_buffer_next
         #
         #   Take the next "item" from the buffer and also return a boolean
         #   indicating if "more" items can be taken. Used for iterating
@@ -152,7 +152,7 @@ def next
           raise NotImplementedError
         end
 
-        # @!macro [attach] channel_buffer_poll
+        # @!macro channel_buffer_poll
         #
         #   Take the next item from the buffer if one is available else return
         #   immediately. Failing to return a value does not necessarily
@@ -166,7 +166,7 @@ def poll
           raise NotImplementedError
         end
 
-        # @!macro [attach] channel_buffer_close
+        # @!macro channel_buffer_close
         #
         #   Close the buffer, preventing new items from being added. Once a
         #   buffer is closed it cannot be opened again.
@@ -179,7 +179,7 @@ def close
           end
         end
 
-        # @!macro [attach] channel_buffer_closed_question
+        # @!macro channel_buffer_closed_question
         #
         #   Predicate indicating is this buffer closed.
         #

lib-edge/concurrent/channel/buffer/unbuffered.rb

@@ -131,7 +131,7 @@ def poll
         # waiting to {#put} items onto the buffer. This method exhibits the
         # same blocking behavior as {#take}.
         #
-        # @see {#take}
+        # @see #take
         def next
           item = take
           more = (item != Concurrent::NULL)

lib-edge/concurrent/edge.rb

@@ -15,16 +15,7 @@ module Concurrent
   # features should remain in this module until merged into the core gem. This
   # will prevent namespace collisions.
   #
-  # @!macro [attach] warn.edge
-  #   @api Edge
-  #   @note **Edge Features** are under active development and may change frequently.
-  #
-  #     -   Deprecations are not added before incompatible changes.
-  #     -   Edge version: _major_ is always 0, _minor_ bump means incompatible change,
-  #         _patch_ bump means compatible change.
-  #     -   Edge features may also lack tests and documentation.
-  #     -   Features developed in `concurrent-ruby-edge` are expected to move
-  #         to `concurrent-ruby` when finalised.
+  # @!macro warn.edge
   module Edge
   end
 end

lib-edge/concurrent/edge/lock_free_linked_set.rb

@@ -22,9 +22,9 @@ module Edge
     class LockFreeLinkedSet
       include Enumerable
 
-      # @!macro [attach] lock_free_linked_list_method_initialize
+      # @!macro lock_free_linked_list_method_initialize
       #
-      # @param [Fixnum] initial_size the size of the linked_list to initialize
+      #   @param [Fixnum] initial_size the size of the linked_list to initialize
       def initialize(initial_size = 0, val = nil)
         @head = Head.new
 
@@ -34,7 +34,7 @@ def initialize(initial_size = 0, val = nil)
         end
       end
 
-      # @!macro [attach] lock_free_linked_list_method_add
+      # @!macro lock_free_linked_list_method_add
       #
       #   Atomically adds the item to the set if it does not yet exist. Note:
       #   internally the set uses `Object#hash` to compare equality of items,
@@ -62,7 +62,7 @@ def add(item)
         end
       end
 
-      # @!macro [attach] lock_free_linked_list_method_<<
+      # @!macro lock_free_linked_list_method_<<
       #
       #   Atomically adds the item to the set if it does not yet exist.
       #
@@ -74,7 +74,7 @@ def <<(item)
         self
       end
 
-      # @!macro [attach] lock_free_linked_list_method_contains
+      # @!macro lock_free_linked_list_method_contains
       #
       #   Atomically checks to see if the set contains an item. This method
       #   compares equality based on the `Object#hash` method, meaning that the
@@ -95,7 +95,7 @@ def contains?(item)
         curr == item && !marked
       end
 
-      # @!macro [attach] lock_free_linked_list_method_remove
+      # @!macro lock_free_linked_list_method_remove
       #
       #   Atomically attempts to remove an item, comparing using `Object#hash`.
       #
@@ -121,7 +121,7 @@ def remove(item)
         end
       end
 
-      # @!macro [attach] lock_free_linked_list_method_each
+      # @!macro lock_free_linked_list_method_each
       #
       #   An iterator to loop through the set.
       #