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_x86_64 = enum(u4) {
/// for absolute addressesX86_64_RELOC_UNSIGNED = 0,
/// for signed 32-bit displacementX86_64_RELOC_SIGNED,
/// a CALL/JMP instruction with 32-bit displacementX86_64_RELOC_BRANCH,
/// a MOVQ load of a GOT entryX86_64_RELOC_GOT_LOAD,
/// other GOT referencesX86_64_RELOC_GOT,
/// must be followed by a X86_64_RELOC_UNSIGNEDX86_64_RELOC_SUBTRACTOR,
/// for signed 32-bit displacement with a -1 addendX86_64_RELOC_SIGNED_1,
/// for signed 32-bit displacement with a -2 addendX86_64_RELOC_SIGNED_2,
/// for signed 32-bit displacement with a -4 addendX86_64_RELOC_SIGNED_4,
/// for thread local variablesX86_64_RELOC_TLV,
}
