executor_service.rb in concurrent-ruby-1.1.0.pre1

- old
+ new

@@ -2,11 +2,11 @@
 
 module Concurrent
 
   ###################################################################
 
-  # @!macro [new] executor_service_method_post
+  # @!macro executor_service_method_post
   #
   #   Submit a task to the executor for asynchronous processing.
   #
   #   @param [Array] args zero or more arguments to be passed to the task
   #
@@ -15,35 +15,35 @@
   #   @return [Boolean] `true` if the task is queued, `false` if the executor
   #     is not running
   #
   #   @raise [ArgumentError] if no task is given
 
-  # @!macro [new] executor_service_method_left_shift
+  # @!macro executor_service_method_left_shift
   #
   #   Submit a task to the executor for asynchronous processing.
   #
   #   @param [Proc] task the asynchronous task to perform
   #
   #   @return [self] returns itself
 
-  # @!macro [new] executor_service_method_can_overflow_question
+  # @!macro executor_service_method_can_overflow_question
   #
   #   Does the task queue have a maximum size?
   #
   #   @return [Boolean] True if the task queue has a maximum size else false.
 
-  # @!macro [new] executor_service_method_serialized_question
+  # @!macro executor_service_method_serialized_question
   #
   #   Does this executor guarantee serialization of its operations?
   #
   #   @return [Boolean] True if the executor guarantees that all operations
   #     will be post in the order they are received and no two operations may
   #     occur simultaneously. Else false.
 
   ###################################################################
 
-  # @!macro [new] executor_service_public_api
+  # @!macro executor_service_public_api
   #
   #   @!method post(*args, &task)
   #     @!macro executor_service_method_post
   #
   #   @!method <<(task)
@@ -55,27 +55,27 @@
   #   @!method serialized?
   #     @!macro executor_service_method_serialized_question
 
   ###################################################################
 
-  # @!macro [new] executor_service_attr_reader_fallback_policy
+  # @!macro executor_service_attr_reader_fallback_policy
   #   @return [Symbol] The fallback policy in effect. Either `:abort`, `:discard`, or `:caller_runs`.
 
-  # @!macro [new] executor_service_method_shutdown
+  # @!macro executor_service_method_shutdown
   #
   #   Begin an orderly shutdown. Tasks already in the queue will be executed,
   #   but no new tasks will be accepted. Has no additional effect if the
   #   thread pool is not running.
 
-  # @!macro [new] executor_service_method_kill
+  # @!macro executor_service_method_kill
   #
   #   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.
 
-  # @!macro [new] executor_service_method_wait_for_termination
+  # @!macro executor_service_method_wait_for_termination
   #
   #   Block until executor shutdown is complete or until `timeout` seconds have
   #   passed.
   #
   #   @note Does not initiate shutdown or termination. Either `shutdown` or `kill`
@@ -83,44 +83,44 @@
   #
   #   @param [Integer] timeout the maximum number of seconds to wait for shutdown to complete
   #
   #   @return [Boolean] `true` if shutdown complete or false on `timeout`
 
-  # @!macro [new] executor_service_method_running_question
+  # @!macro executor_service_method_running_question
   #
   #   Is the executor running?
   #
   #   @return [Boolean] `true` when running, `false` when shutting down or shutdown
 
-  # @!macro [new] executor_service_method_shuttingdown_question
+  # @!macro executor_service_method_shuttingdown_question
   #
   #   Is the executor shuttingdown?
   #
   #   @return [Boolean] `true` when not running and not shutdown, else `false`
 
-  # @!macro [new] executor_service_method_shutdown_question
+  # @!macro executor_service_method_shutdown_question
   #
   #   Is the executor shutdown?
   #
   #   @return [Boolean] `true` when shutdown, `false` when shutting down or running
 
-  # @!macro [new] executor_service_method_auto_terminate_question
+  # @!macro executor_service_method_auto_terminate_question
   #
   #   Is the executor auto-terminate when the application exits?
   #
   #   @return [Boolean] `true` when auto-termination is enabled else `false`.
 
-  # @!macro [new] executor_service_method_auto_terminate_setter
+  # @!macro executor_service_method_auto_terminate_setter
   #
   #   Set the auto-terminate behavior for this executor.
   #
   #   @param [Boolean] value The new auto-terminate value to set for this executor.
   #
   #   @return [Boolean] `true` when auto-termination is enabled else `false`.
 
   ###################################################################
 
-  # @!macro [new] abstract_executor_service_public_api
+  # @!macro abstract_executor_service_public_api
   #
   #   @!macro executor_service_public_api
   #
   #   @!attribute [r] fallback_policy
   #     @!macro executor_service_attr_reader_fallback_policy