Skip to content
This repository was archived by the owner on Oct 12, 2022. It is now read-only.

Commit 7eced51

Browse files
Merge pull request #2350 from n8sh/issue-19398
Fix Issue 19398 - Document meaning of core.atomic.MemoryOrder
2 parents a104ca6 + 5fc0513 commit 7eced51

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

src/core/atomic.d

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -249,13 +249,26 @@ version (CoreDdoc)
249249

250250
/**
251251
* Specifies the memory ordering semantics of an atomic operation.
252+
*
253+
* See_Also:
254+
* $(HTTP en.cppreference.com/w/cpp/atomic/memory_order)
252255
*/
253256
enum MemoryOrder
254257
{
255-
raw, /// Not sequenced.
256-
acq, /// Hoist-load + hoist-store barrier.
257-
rel, /// Sink-load + sink-store barrier.
258-
seq, /// Fully sequenced (acquire + release).
258+
/// Not sequenced.
259+
/// Corresponds to $(LINK2 https://llvm.org/docs/Atomics.html#monotonic, LLVM AtomicOrdering.Monotonic).
260+
raw,
261+
/// Hoist-load + hoist-store barrier.
262+
/// Corresponds to $(LINK2 https://llvm.org/docs/Atomics.html#acquire, LLVM AtomicOrdering.Acquire).
263+
acq,
264+
/// Sink-load + sink-store barrier.
265+
/// Corresponds to $(LINK2 https://llvm.org/docs/Atomics.html#release, LLVM AtomicOrdering.Release).
266+
rel,
267+
/++
268+
Fully sequenced (acquire + release). Corresponds to
269+
$(LINK2 https://llvm.org/docs/Atomics.html#sequentiallyconsistent, LLVM AtomicOrdering.SequentiallyConsistent)
270+
+/
271+
seq,
259272
}
260273

261274
deprecated("Please use MemoryOrder instead.")

0 commit comments

Comments
 (0)