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
ARM
Public Enum
std.coff.IMAGE.REL.ARM
pubconstARM = enum(u16)
ARM Processors The following relocation type indicators are defined for ARM processors.
pubconstARM = enum(u16) {
/// The relocation is ignored.ABSOLUTE = 0x0000,
/// The 32-bit VA of the target.ADDR32 = 0x0001,
/// The 32-bit RVA of the target.ADDR32NB = 0x0002,
/// The 24-bit relative displacement to the target.BRANCH24 = 0x0003,
/// The reference to a subroutine call./// The reference consists of two 16-bit instructions with 11-bit offsets.BRANCH11 = 0x0004,
/// The 32-bit relative address from the byte following the relocation.REL32 = 0x000A,
/// The 16-bit section index of the section that contains the target./// This is used to support debugging information.SECTION = 0x000E,
/// 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 = 0x000F,
/// The 32-bit VA of the target./// This relocation is applied using a MOVW instruction for the low 16 bits followed by a MOVT for the high 16 bits.MOV32 = 0x0010,
/// The 32-bit VA of the target./// This relocation is applied using a MOVW instruction for the low 16 bits followed by a MOVT for the high 16 bits.THUMB_MOV32 = 0x0011,
/// The instruction is fixed up with the 21-bit relative displacement to the 2-byte aligned target./// The least significant bit of the displacement is always zero and is not stored./// This relocation corresponds to a Thumb-2 32-bit conditional B instruction.THUMB_BRANCH20 = 0x0012,
Unused = 0x0013,
/// The instruction is fixed up with the 25-bit relative displacement to the 2-byte aligned target./// The least significant bit of the displacement is zero and is not stored.This relocation corresponds to a Thumb-2 B instruction.THUMB_BRANCH24 = 0x0014,
/// The instruction is fixed up with the 25-bit relative displacement to the 4-byte aligned target./// The low 2 bits of the displacement are zero and are not stored./// This relocation corresponds to a Thumb-2 BLX instruction.THUMB_BLX23 = 0x0015,
/// The relocation is valid only when it immediately follows a ARM_REFHI or THUMB_REFHI./// Its SymbolTableIndex contains a displacement and not an index into the symbol table.PAIR = 0x0016,
_,
}
ARM Processors The following relocation type indicators are defined for ARM processors.