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
pubfnaddWrap(r: *Mutable, a: Const, b: Const, signedness: Signedness, bit_count: usize) bool {
constreq_limbs = calcTwosCompLimbCount(bit_count);
// Slice of the upper bits if they exist, these will be ignored and allows us to use addCarry to determine// if an overflow occurred.constx: Const = .{
.positive = a.positive,
.limbs = a.limbs[0..@min(req_limbs, a.limbs.len)],
};
consty: Const = .{
.positive = b.positive,
.limbs = b.limbs[0..@min(req_limbs, b.limbs.len)],
};
varcarry_truncated = false;
if (r.addCarry(x, y)) {
// There are two possibilities here:// - We overflowed req_limbs. In this case, the carry is ignored, as it would be removed by// truncate anyway.// - a and b had less elements than req_limbs, and those were overflowed. This case needs to be handled.// Note: after this we still might need to wrap.constmsl = @max(a.limbs.len, b.limbs.len);
if (msl < req_limbs) {
r.len = msl + 1;
r.limbs[msl] = 1;
} else {
carry_truncated = true;
}
}
if (!r.toConst().fitsInTwosComp(signedness, bit_count)) {
r.truncate(r.toConst(), signedness, bit_count);
returntrue;
}
returncarry_truncated;
}
r = a + b with 2s-complement wrapping semantics. Returns whether overflow occurred. r, a and b may be aliases
Asserts the result fits in
r. An upper bound on the number of limbs needed by r iscalcTwosCompLimbCount(bit_count).