Skip to content

Commit ac4ac26

Browse files
committed
Fixed Yardoc problems.
1 parent fbb2e1f commit ac4ac26

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

lib/concurrent/agent.rb

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,18 @@ class Agent
2121
#
2222
# @param [Object] initial the initial value
2323
#
24-
# @!macro executor_and_deref_options
24+
# @!macro [attach] executor_and_deref_options
25+
#
26+
# @param [Hash] opts the options used to define the behavior at update and deref
27+
# and to specify the executor on which to perform actions
28+
# @option opts [Executor] :executor when set use the given `Executor` instance.
29+
# Three special values are also supported: `:task` returns the global task pool,
30+
# `:operation` returns the global operation pool, and `:immediate` returns a new
31+
# `ImmediateExecutor` object.
32+
# @option opts [Boolean] :dup_on_deref (false) call `#dup` before returning the data
33+
# @option opts [Boolean] :freeze_on_deref (false) call `#freeze` before returning the data
34+
# @option opts [Proc] :copy_on_deref (nil) call the given `Proc` passing
35+
# the internal value and returning the value returned from the proc
2536
def initialize(initial, opts = {})
2637
@value = initial
2738
@rescuers = []

lib/concurrent/atomic/thread_local_var/weak_key_map.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,9 @@ def object
164164
end
165165
end
166166
end
167-
end
168167

169-
private_constant :WeakReference
168+
private_constant :WeakReference
169+
end
170170

171171
# The classes behave similar to Hashes, but the keys in the map are not strong references
172172
# and can be reclaimed by the garbage collector at any time. When a key is reclaimed, the

lib/concurrent/delay.rb

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,7 @@ class Delay < Synchronization::Object
5151

5252
# Create a new `Delay` in the `:pending` state.
5353
#
54-
# @!macro [attach] executor_and_deref_options
55-
#
56-
# @param [Hash] opts the options used to define the behavior at update and deref
57-
# and to specify the executor on which to perform actions
58-
# @option opts [Executor] :executor when set use the given `Executor` instance.
59-
# Three special values are also supported: `:task` returns the global task pool,
60-
# `:operation` returns the global operation pool, and `:immediate` returns a new
61-
# `ImmediateExecutor` object.
62-
# @option opts [Boolean] :dup_on_deref (false) call `#dup` before returning the data
63-
# @option opts [Boolean] :freeze_on_deref (false) call `#freeze` before returning the data
64-
# @option opts [Proc] :copy_on_deref (nil) call the given `Proc` passing
65-
# the internal value and returning the value returned from the proc
54+
# @!macro executor_and_deref_options
6655
#
6756
# @yield the delayed operation to perform
6857
#

0 commit comments

Comments
 (0)