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 Function
r = a ^ b under 2s complement semantics. r may alias with a or b.
Asserts that r has enough limbs to store the result. If a and b share the same signedness, the upper bound is @max(a.limbs.len, b.limbs.len). Otherwise, if either a or b is negative but not both, the upper bound is @max(a.limbs.len, b.limbs.len) + 1.
r = a ^ b under 2s complement semantics. r may alias with a or b.
Asserts that r has enough limbs to store the result. If a and b share the same signedness, the upper bound is
@max(a.limbs.len, b.limbs.len). Otherwise, if either a or b is negative but not both, the upper bound is@max(a.limbs.len, b.limbs.len) + 1.