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
pubfndwarfRegisterBytes(ctx: *Hexagon, register_num: u16) DwarfRegisterError![]u8 {
// Sourced from LLVM's HexagonRegisterInfo.td, which disagrees with LLDB...switch (register_num) {
0...31 => return@ptrCast(&ctx.r[register_num]),
76 => return@ptrCast(&ctx.pc),
// This is probably covering some numbers that aren't actually mapped, but seriously,// look at that file. I really can't be bothered to make it more precise.32...75 => returnerror.UnsupportedRegister,
77...259 => returnerror.UnsupportedRegister,
// 999999...1000030 => return error.UnsupportedRegister,// 9999999...10000030 => return error.UnsupportedRegister,else => returnerror.InvalidRegister,
}
}