Skip to content

Commit

Permalink
Update return value docs in atomics docs
Browse files Browse the repository at this point in the history
Fixes #21668
  • Loading branch information
steveklabnik committed Mar 27, 2015
1 parent 242ed0b commit 1a6188a
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions src/libcore/atomic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,8 @@ impl AtomicBool {

/// Stores a value into the bool if the current value is the same as the expected value.
///
/// If the return value is equal to `old` then the value was updated.
/// The return value is always the previous value. If it is equal to `old`, then the value was
/// updated.
///
/// `swap` also takes an `Ordering` argument which describes the memory ordering of this
/// operation.
Expand Down Expand Up @@ -489,7 +490,8 @@ impl AtomicIsize {

/// Stores a value into the isize if the current value is the same as the expected value.
///
/// If the return value is equal to `old` then the value was updated.
/// The return value is always the previous value. If it is equal to `old`, then the value was
/// updated.
///
/// `compare_and_swap` also takes an `Ordering` argument which describes the memory ordering of
/// this operation.
Expand Down Expand Up @@ -676,7 +678,8 @@ impl AtomicUsize {

/// Stores a value into the usize if the current value is the same as the expected value.
///
/// If the return value is equal to `old` then the value was updated.
/// The return value is always the previous value. If it is equal to `old`, then the value was
/// updated.
///
/// `compare_and_swap` also takes an `Ordering` argument which describes the memory ordering of
/// this operation.
Expand Down Expand Up @@ -873,7 +876,8 @@ impl<T> AtomicPtr<T> {

/// Stores a value into the pointer if the current value is the same as the expected value.
///
/// If the return value is equal to `old` then the value was updated.
/// The return value is always the previous value. If it is equal to `old`, then the value was
/// updated.
///
/// `compare_and_swap` also takes an `Ordering` argument which describes the memory ordering of
/// this operation.
Expand Down

0 comments on commit 1a6188a

Please sign in to comment.