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. Private Enum
AccOp
Private Enum
std.math.big.int.AccOp
constAccOp = enum
Different operators which can be used in accumulation style functions (llmulacc, llmulaccKaratsuba, llmulaccLong, llmulLimb). In all these functions, a computed value is accumulated with an existing result.
File
math/big/int.zig:3628
3628362936303631363236333634
constAccOp = enum {
/// The computed value is added to the result.add,
/// The computed value is subtracted from the result.sub,
}
Different operators which can be used in accumulation style functions (llmulacc, llmulaccKaratsuba, llmulaccLong, llmulLimb). In all these functions, a computed value is accumulated with an existing result.