Commit eb4d93ece3

daurnimator <quae@daurnimator.com>
2020-11-18 14:44:38
std: some more docs for std.atomic.Int
1 parent 513e816
Changed files (1)
lib
std
atomic
lib/std/atomic/int.zig
@@ -30,11 +30,13 @@ pub fn Int(comptime T: type) type {
             @atomicStore(T, &self.unprotected_value, value, ordering);
         }
 
+        /// Twos complement wraparound increment
         /// Returns previous value
         pub fn incr(self: *Self) T {
             return self.rmw(.Add, 1, .SeqCst);
         }
 
+        /// Twos complement wraparound decrement
         /// Returns previous value
         pub fn decr(self: *Self) T {
             return self.rmw(.Sub, 1, .SeqCst);
@@ -52,6 +54,8 @@ pub fn Int(comptime T: type) type {
             return self.rmw(.Xchg, new_value, .SeqCst);
         }
 
+        /// Twos complement wraparound add
+        /// Returns previous value
         pub fn fetchAdd(self: *Self, op: T) T {
             return self.rmw(.Add, op, .SeqCst);
         }