Skip to content

Commit 3907b93

Browse files
Add missing urls in AtomicBool docs
1 parent 1b38776 commit 3907b93

File tree

1 file changed

+35
-13
lines changed

1 file changed

+35
-13
lines changed

src/libcore/sync/atomic.rs

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -237,11 +237,16 @@ impl AtomicBool {
237237

238238
/// Loads a value from the bool.
239239
///
240-
/// `load` takes an `Ordering` argument which describes the memory ordering of this operation.
240+
/// `load` takes an [`Ordering`] argument which describes the memory ordering
241+
/// of this operation.
241242
///
242243
/// # Panics
243244
///
244-
/// Panics if `order` is `Release` or `AcqRel`.
245+
/// Panics if `order` is [`Release`] or [`AcqRel`].
246+
///
247+
/// [`Ordering`]: enum.Ordering.html
248+
/// [`Release`]: enum.Ordering.html#variant.Release
249+
/// [`AcqRel`]: enum.Ordering.html#variant.Release
245250
///
246251
/// # Examples
247252
///
@@ -260,7 +265,10 @@ impl AtomicBool {
260265

261266
/// Stores a value into the bool.
262267
///
263-
/// `store` takes an `Ordering` argument which describes the memory ordering of this operation.
268+
/// `store` takes an [`Ordering`] argument which describes the memory ordering
269+
/// of this operation.
270+
///
271+
/// [`Ordering`]: enum.Ordering.html
264272
///
265273
/// # Examples
266274
///
@@ -286,7 +294,10 @@ impl AtomicBool {
286294

287295
/// Stores a value into the bool, returning the old value.
288296
///
289-
/// `swap` takes an `Ordering` argument which describes the memory ordering of this operation.
297+
/// `swap` takes an [`Ordering`] argument which describes the memory ordering
298+
/// of this operation.
299+
///
300+
/// [`Ordering`]: enum.Ordering.html
290301
///
291302
/// # Examples
292303
///
@@ -309,8 +320,10 @@ impl AtomicBool {
309320
/// The return value is always the previous value. If it is equal to `current`, then the value
310321
/// was updated.
311322
///
312-
/// `compare_and_swap` also takes an `Ordering` argument which describes the memory ordering of
313-
/// this operation.
323+
/// `compare_and_swap` also takes an [`Ordering`] argument which describes the memory
324+
/// ordering of this operation.
325+
///
326+
/// [`Ordering`]: enum.Ordering.html
314327
///
315328
/// # Examples
316329
///
@@ -339,10 +352,15 @@ impl AtomicBool {
339352
/// The return value is a result indicating whether the new value was written and containing
340353
/// the previous value. On success this value is guaranteed to be equal to `current`.
341354
///
342-
/// `compare_exchange` takes two `Ordering` arguments to describe the memory ordering of this
343-
/// operation. The first describes the required ordering if the operation succeeds while the
344-
/// second describes the required ordering when the operation fails. The failure ordering can't
345-
/// be `Release` or `AcqRel` and must be equivalent or weaker than the success ordering.
355+
/// `compare_exchange` takes two [`Ordering`] arguments to describe the memory
356+
/// ordering of this operation. The first describes the required ordering if the
357+
/// operation succeeds while the second describes the required ordering when the
358+
/// operation fails. The failure ordering can't be [`Release`] or [`AcqRel`] and must
359+
/// be equivalent or weaker than the success ordering.
360+
///
361+
/// [`Ordering`]: enum.Ordering.html
362+
/// [`Release`]: enum.Ordering.html#variant.Release
363+
/// [`AcqRel`]: enum.Ordering.html#variant.Release
346364
///
347365
/// # Examples
348366
///
@@ -387,11 +405,15 @@ impl AtomicBool {
387405
/// return value is a result indicating whether the new value was written and containing the
388406
/// previous value.
389407
///
390-
/// `compare_exchange_weak` takes two `Ordering` arguments to describe the memory
408+
/// `compare_exchange_weak` takes two [`Ordering`] arguments to describe the memory
391409
/// ordering of this operation. The first describes the required ordering if the operation
392410
/// succeeds while the second describes the required ordering when the operation fails. The
393-
/// failure ordering can't be `Release` or `AcqRel` and must be equivalent or weaker than the
394-
/// success ordering.
411+
/// failure ordering can't be [`Release`] or [`AcqRel`] and must be equivalent or
412+
/// weaker than the success ordering.
413+
///
414+
/// [`Ordering`]: enum.Ordering.html
415+
/// [`Release`]: enum.Ordering.html#variant.Release
416+
/// [`AcqRel`]: enum.Ordering.html#variant.Release
395417
///
396418
/// # Examples
397419
///

0 commit comments

Comments
 (0)