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 Type Function
Static
Public Type Function
std.bit_set.Static
pubfnStatic(comptimesize: usize) type
Returns the optimal static bit set type for the specified number of elements: either IntegerBitSet or ArrayBitSet, both of which fulfill the same interface. The returned type will perform no allocations, can be copied by value, and does not require deinitialization.
File
bit_set.zig:45
45464748495051
pubfnStatic(comptimesize: usize) type {
if (size <= @bitSizeOf(usize)) {
returnInteger(size);
} else {
returnArray(usize, size);
}
}
Returns the optimal static bit set type for the specified number of elements: either
IntegerBitSetorArrayBitSet, both of which fulfill the same interface. The returned type will perform no allocations, can be copied by value, and does not require deinitialization.