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 Enum
AMD64
Public Enum
std.coff.IMAGE.REL.AMD64
pubconstAMD64 = enum(u16)
x64 Processors The following relocation type indicators are defined for x64 and compatible processors.
pubconstAMD64 = enum(u16) {
/// The relocation is ignored.ABSOLUTE = 0x0000,
/// The 64-bit VA of the relocation target.ADDR64 = 0x0001,
/// The 32-bit VA of the relocation target.ADDR32 = 0x0002,
/// The 32-bit address without an image base (RVA).ADDR32NB = 0x0003,
/// The 32-bit relative address from the byte following the relocation.REL32 = 0x0004,
/// The 32-bit address relative to byte distance 1 from the relocation.REL32_1 = 0x0005,
/// The 32-bit address relative to byte distance 2 from the relocation.REL32_2 = 0x0006,
/// The 32-bit address relative to byte distance 3 from the relocation.REL32_3 = 0x0007,
/// The 32-bit address relative to byte distance 4 from the relocation.REL32_4 = 0x0008,
/// The 32-bit address relative to byte distance 5 from the relocation.REL32_5 = 0x0009,
/// The 16-bit section index of the section that contains the target./// This is used to support debugging information.SECTION = 0x000A,
/// The 32-bit offset of the target from the beginning of its section./// This is used to support debugging information and static thread local storage.SECREL = 0x000B,
/// A 7-bit unsigned offset from the base of the section that contains the target.SECREL7 = 0x000C,
/// CLR tokens.TOKEN = 0x000D,
/// A 32-bit signed span-dependent value emitted into the object.SREL32 = 0x000E,
/// A pair that must immediately follow every span-dependent value.PAIR = 0x000F,
/// A 32-bit signed span-dependent value that is applied at link time.SSPAN32 = 0x0010,
_,
}
x64 Processors The following relocation type indicators are defined for x64 and compatible processors.