Updated yardoc

Author: jdantonio

lib/concurrent/executor/executor_service.rb

@@ -82,7 +82,7 @@ def serialized?
   module SerialExecutorService
     include ExecutorService
 
-    # @!macro executor_module_method_serialized_question
+    # @!macro executor_service_method_serialized_question
     #
     # @note Always returns `true`
     def serialized?

lib/concurrent/executor/immediate_executor.rb

@@ -21,43 +21,43 @@ def initialize
       @stopped = Concurrent::Event.new
     end
 
-    # @!macro executor_method_post
+    # @!macro executor_service_method_post
     def post(*args, &task)
       raise ArgumentError.new('no block given') unless block_given?
       return false unless running?
       task.call(*args)
       true
     end
 
-    # @!macro executor_method_left_shift
+    # @!macro executor_service_method_left_shift
     def <<(task)
       post(&task)
       self
     end
 
-    # @!macro executor_method_running_question
+    # @!macro executor_service_method_running_question
     def running?
       ! shutdown?
     end
 
-    # @!macro executor_method_shuttingdown_question
+    # @!macro executor_service_method_shuttingdown_question
     def shuttingdown?
       false
     end
 
-    # @!macro executor_method_shutdown_question
+    # @!macro executor_service_method_shutdown_question
     def shutdown?
       @stopped.set?
     end
 
-    # @!macro executor_method_shutdown
+    # @!macro executor_service_method_shutdown
     def shutdown
       @stopped.set
       true
     end
     alias_method :kill, :shutdown
 
-    # @!macro executor_method_wait_for_termination
+    # @!macro executor_service_method_wait_for_termination
     def wait_for_termination(timeout = nil)
       @stopped.wait(timeout)
     end

lib/concurrent/executor/indirect_immediate_executor.rb

@@ -23,7 +23,7 @@ def initialize
       @internal_executor = SimpleExecutorService.new
     end
 
-    # @!macro executor_method_post
+    # @!macro executor_service_method_post
     def post(*args, &task)
       raise ArgumentError.new("no block given") unless block_given?
       return false unless running?

lib/concurrent/executor/java_thread_pool_executor.rb

@@ -55,7 +55,7 @@ def initialize(opts = {})
         super(opts)
       end
 
-      # @!macro executor_module_method_can_overflow_question
+      # @!macro executor_service_method_can_overflow_question
       def can_overflow?
         @max_queue != 0
       end

lib/concurrent/executor/ruby_thread_pool_executor.rb

@@ -73,7 +73,7 @@ def initialize(opts = {})
       super(opts)
     end
 
-    # @!macro executor_module_method_can_overflow_question
+    # @!macro executor_service_method_can_overflow_question
     def can_overflow?
       synchronize { ns_limited_queue? }
     end

lib/concurrent/executor/serialized_execution.rb

@@ -115,7 +115,7 @@ def initialize(executor)
       super(executor)
     end
 
-    # @!macro executor_method_post
+    # @!macro executor_service_method_post
     def post(*args, &task)
       raise ArgumentError.new('no block given') unless block_given?
       return false unless running?

lib/concurrent/executor/simple_executor_service.rb

@@ -17,7 +17,7 @@ module Concurrent
   # @note Intended for use primarily in testing and debugging.
   class SimpleExecutorService < RubyExecutorService
 
-    # @!macro executor_method_post
+    # @!macro executor_service_method_post
     def self.post(*args)
       raise ArgumentError.new('no block given') unless block_given?
       Thread.new(*args) do
@@ -27,13 +27,13 @@ def self.post(*args)
       true
     end
 
-    # @!macro executor_method_left_shift
+    # @!macro executor_service_method_left_shift
     def self.<<(task)
       post(&task)
       self
     end
 
-    # @!macro executor_method_post
+    # @!macro executor_service_method_post
     def post(*args, &task)
       raise ArgumentError.new('no block given') unless block_given?
       return false unless running?
@@ -49,42 +49,42 @@ def post(*args, &task)
       end
     end
 
-    # @!macro executor_method_left_shift
+    # @!macro executor_service_method_left_shift
     def <<(task)
       post(&task)
       self
     end
 
-    # @!macro executor_method_running_question
+    # @!macro executor_service_method_running_question
     def running?
       @running.true?
     end
 
-    # @!macro executor_method_shuttingdown_question
+    # @!macro executor_service_method_shuttingdown_question
     def shuttingdown?
       @running.false? && ! @stopped.set?
     end
 
-    # @!macro executor_method_shutdown_question
+    # @!macro executor_service_method_shutdown_question
     def shutdown?
       @stopped.set?
     end
 
-    # @!macro executor_method_shutdown
+    # @!macro executor_service_method_shutdown
     def shutdown
       @running.make_false
       @stopped.set if @count.value == 0
       true
     end
 
-    # @!macro executor_method_kill
+    # @!macro executor_service_method_kill
     def kill
       @running.make_false
       @stopped.set
       true
     end
 
-    # @!macro executor_method_wait_for_termination
+    # @!macro executor_service_method_wait_for_termination
     def wait_for_termination(timeout = nil)
       @stopped.wait(timeout)
     end

lib/concurrent/executor/timer_set.rb

@@ -60,13 +60,10 @@ def post(delay, *args, &task)
       true
     end
 
-    # @!visibility private
-    def <<(task)
-      post(0.0, &task)
-      self
-    end
-
-    # @!macro executor_method_shutdown
+    # Begin an immediate shutdown. In-progress tasks will be allowed to
+    # complete but enqueued tasks will be dismissed and no new tasks
+    # will be accepted. Has no additional effect if the thread pool is
+    # not running.
     def kill
       shutdown
     end
@@ -162,5 +159,12 @@ def process_tasks
         end
       end
     end
+
+    private
+
+    def <<(task)
+      post(0.0, &task)
+      self
+    end
   end
 end