Zig 0.17.0-dev (Split by item)

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 library itself.

typeHasWrappingOverflow

Translator.typeHasWrappingOverflow

fn typeHasWrappingOverflow(t: *Translator, qt: QualType) bool

File

lib/compiler/translate-c/Translator.zig:1605

Code

fn typeHasWrappingOverflow(t: *Translator, qt: QualType) bool {
    if (t.signedness(qt) == .unsigned) {
        // unsigned integer overflow wraps around.
        return true;
    } else {
        // float, signed integer, and pointer overflow is undefined behavior.
        return false;
    }
}