This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Enum
AtomicRmwOp
Public Enum
std.lang.AtomicRmwOp
pubconstAtomicRmwOp = enum
This data structure is used by the Zig language code generation and therefore must be kept in sync with the compiler implementation.
pubconstAtomicRmwOp = enum {
/// Exchange - store the operand unmodified./// Supports enums, integers, and floats.Xchg,
/// Add operand to existing value./// Supports integers and floats./// For integers, two's complement wraparound applies.Add,
/// Subtract operand from existing value./// Supports integers and floats./// For integers, two's complement wraparound applies.Sub,
/// Perform bitwise AND on existing value with operand./// Supports integers.And,
/// Perform bitwise NAND on existing value with operand./// Supports integers.Nand,
/// Perform bitwise OR on existing value with operand./// Supports integers.Or,
/// Perform bitwise XOR on existing value with operand./// Supports integers.Xor,
/// Store operand if it is larger than the existing value./// Supports integers and floats.Max,
/// Store operand if it is smaller than the existing value./// Supports integers and floats.Min,
}
This data structure is used by the Zig language code generation and therefore must be kept in sync with the compiler implementation.