Skip to content

Commit 031c29c

Browse files
committed
Updated yardoc for AtomicMarkableReference.
1 parent 176ca73 commit 031c29c

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

lib/concurrent/edge/atomic_markable_reference.rb

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
module Concurrent
22
module Edge
3-
# @!macro atomic_markable_reference
3+
4+
# @!macro [attach] atomic_markable_reference
5+
#
6+
# An atomic reference which maintains an object reference along with a mark bit
7+
# that can be updated atomically.
8+
#
9+
# @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicMarkableReference.html java.util.concurrent.atomic.AtomicMarkableReference
10+
#
11+
# @api Edge
412
class AtomicMarkableReference < ::Concurrent::Synchronization::Object
13+
514
# @!macro [attach] atomic_markable_reference_method_initialize
615
def initialize(value = nil, mark = false)
716
super()
@@ -16,9 +25,9 @@ def initialize(value = nil, mark = false)
1625
# - the current value == the expected value &&
1726
# - the current mark == the expected mark
1827
#
19-
# @param [Object] old_val the expected value
28+
# @param [Object] expected_val the expected value
2029
# @param [Object] new_val the new value
21-
# @param [Boolean] old_mark the expected mark
30+
# @param [Boolean] expected_mark the expected mark
2231
# @param [Boolean] new_mark the new mark
2332
#
2433
# @return [Boolean] `true` if successful. A `false` return indicates

0 commit comments

Comments
 (0)