Skip to content

Commit 94d58c2

Browse files
Add missing urls for atomic_int macros types
1 parent 1b38776 commit 94d58c2

File tree

1 file changed

+36
-17
lines changed

1 file changed

+36
-17
lines changed

src/libcore/sync/atomic.rs

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -913,12 +913,16 @@ macro_rules! atomic_int {
913913

914914
/// Loads a value from the atomic integer.
915915
///
916-
/// `load` takes an `Ordering` argument which describes the memory ordering of this
916+
/// `load` takes an [`Ordering`] argument which describes the memory ordering of this
917917
/// operation.
918918
///
919919
/// # Panics
920920
///
921-
/// Panics if `order` is `Release` or `AcqRel`.
921+
/// Panics if `order` is [`Release`] or [`AcqRel`].
922+
///
923+
/// [`Ordering`]: enum.Ordering.html
924+
/// [`Release`]: enum.Ordering.html#variant.Release
925+
/// [`AcqRel`]: enum.Ordering.html#variant.AcqRel
922926
///
923927
/// # Examples
924928
///
@@ -937,9 +941,11 @@ macro_rules! atomic_int {
937941

938942
/// Stores a value into the atomic integer.
939943
///
940-
/// `store` takes an `Ordering` argument which describes the memory ordering of this
944+
/// `store` takes an [`Ordering`] argument which describes the memory ordering of this
941945
/// operation.
942946
///
947+
/// [`Ordering`]: enum.Ordering.html
948+
///
943949
/// # Examples
944950
///
945951
/// ```
@@ -962,9 +968,11 @@ macro_rules! atomic_int {
962968

963969
/// Stores a value into the atomic integer, returning the old value.
964970
///
965-
/// `swap` takes an `Ordering` argument which describes the memory ordering of this
971+
/// `swap` takes an [`Ordering`] argument which describes the memory ordering of this
966972
/// operation.
967973
///
974+
/// [`Ordering`]: enum.Ordering.html
975+
///
968976
/// # Examples
969977
///
970978
/// ```
@@ -986,9 +994,11 @@ macro_rules! atomic_int {
986994
/// The return value is always the previous value. If it is equal to `current`, then the
987995
/// value was updated.
988996
///
989-
/// `compare_and_swap` also takes an `Ordering` argument which describes the memory
997+
/// `compare_and_swap` also takes an [`Ordering`] argument which describes the memory
990998
/// ordering of this operation.
991999
///
1000+
/// [`Ordering`]: enum.Ordering.html
1001+
///
9921002
/// # Examples
9931003
///
9941004
/// ```
@@ -1024,11 +1034,15 @@ macro_rules! atomic_int {
10241034
/// containing the previous value. On success this value is guaranteed to be equal to
10251035
/// `current`.
10261036
///
1027-
/// `compare_exchange` takes two `Ordering` arguments to describe the memory ordering of
1028-
/// this operation. The first describes the required ordering if the operation succeeds
1029-
/// while the second describes the required ordering when the operation fails. The
1030-
/// failure ordering can't be `Release` or `AcqRel` and must be equivalent or weaker
1031-
/// than the success ordering.
1037+
/// `compare_exchange` takes two [`Ordering`] arguments to describe the memory
1038+
/// ordering of this operation. The first describes the required ordering if
1039+
/// the operation succeeds while the second describes the required ordering when
1040+
/// the operation fails. The failure ordering can't be [`Release`] or [`AcqRel`] and
1041+
/// must be equivalent or weaker than the success ordering.
1042+
///
1043+
/// [`Ordering`]: enum.Ordering.html
1044+
/// [`Release`]: enum.Ordering.html#variant.Release
1045+
/// [`AcqRel`]: enum.Ordering.html#variant.AcqRel
10321046
///
10331047
/// # Examples
10341048
///
@@ -1062,16 +1076,21 @@ macro_rules! atomic_int {
10621076
/// Stores a value into the atomic integer if the current value is the same as the
10631077
/// `current` value.
10641078
///
1065-
/// Unlike `compare_exchange`, this function is allowed to spuriously fail even when the
1066-
/// comparison succeeds, which can result in more efficient code on some platforms. The
1067-
/// return value is a result indicating whether the new value was written and containing
1068-
/// the previous value.
1079+
/// Unlike [`compare_exchange`], this function is allowed to spuriously fail even
1080+
/// when the comparison succeeds, which can result in more efficient code on some
1081+
/// platforms. The return value is a result indicating whether the new value was
1082+
/// written and containing the previous value.
10691083
///
1070-
/// `compare_exchange_weak` takes two `Ordering` arguments to describe the memory
1084+
/// `compare_exchange_weak` takes two [`Ordering`] arguments to describe the memory
10711085
/// ordering of this operation. The first describes the required ordering if the
10721086
/// operation succeeds while the second describes the required ordering when the
1073-
/// operation fails. The failure ordering can't be `Release` or `AcqRel` and must be
1074-
/// equivalent or weaker than the success ordering.
1087+
/// operation fails. The failure ordering can't be [`Release`] or [`AcqRel`] and
1088+
/// must be equivalent or weaker than the success ordering.
1089+
///
1090+
/// [`compare_exchange`]: #method.compare_exchange
1091+
/// [`Ordering`]: enum.Ordering.html
1092+
/// [`Release`]: enum.Ordering.html#variant.Release
1093+
/// [`AcqRel`]: enum.Ordering.html#variant.AcqRel
10751094
///
10761095
/// # Examples
10771096
///

0 commit comments

Comments
 (0)