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.

bad

This function is to make it handy to comment out the return and make it into a crash when working on this file.

Dwarf.bad

pub fn bad() error

File

lib/std/debug/Dwarf.zig:1535

Code

pub fn bad() error{InvalidDebugInfo} {
    invalidDebugInfoDetected();
    return error.InvalidDebugInfo;
}