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
ceilPowerOfTwoAssert
Public Function
std.math.ceilPowerOfTwoAssert
pubfnceilPowerOfTwoAssert(comptimeT: type, value: T) T
Returns the next power of two (if the value is not already a power of two). Only unsigned integers can be used. Zero is not an allowed input. Asserts that the value fits.
Params
T: type
value: T
File
math.zig:1237
123712381239
pubfnceilPowerOfTwoAssert(comptimeT: type, value: T) T {
returnceilPowerOfTwo(T, value) catchunreachable;
}
Returns the next power of two (if the value is not already a power of two). Only unsigned integers can be used. Zero is not an allowed input. Asserts that the value fits.