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.
pubconstreloc_type_arm64 = enum(u4) {
/// For pointers.ARM64_RELOC_UNSIGNED = 0,
/// Must be followed by a ARM64_RELOC_UNSIGNED.ARM64_RELOC_SUBTRACTOR,
/// A B/BL instruction with 26-bit displacement.ARM64_RELOC_BRANCH26,
/// Pc-rel distance to page of target.ARM64_RELOC_PAGE21,
/// Offset within page, scaled by r_length.ARM64_RELOC_PAGEOFF12,
/// Pc-rel distance to page of GOT slot.ARM64_RELOC_GOT_LOAD_PAGE21,
/// Offset within page of GOT slot, scaled by r_length.ARM64_RELOC_GOT_LOAD_PAGEOFF12,
/// For pointers to GOT slots.ARM64_RELOC_POINTER_TO_GOT,
/// Pc-rel distance to page of TLVP slot.ARM64_RELOC_TLVP_LOAD_PAGE21,
/// Offset within page of TLVP slot, scaled by r_length.ARM64_RELOC_TLVP_LOAD_PAGEOFF12,
/// Must be followed by PAGE21 or PAGEOFF12.ARM64_RELOC_ADDEND,
}