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
I386
Public Enum
std.coff.IMAGE.REL.I386
pubconstI386 = enum(u16)
Intel 386 Processors The following relocation type indicators are defined for Intel 386 and compatible processors.
pubconstI386 = enum(u16) {
/// The relocation is ignored.ABSOLUTE = 0x0000,
/// Not supported.DIR16 = 0x0001,
/// Not supported.REL16 = 0x0002,
/// The target's 32-bit VA.DIR32 = 0x0006,
/// The target's 32-bit RVA.DIR32NB = 0x0007,
/// Not supported.SEG12 = 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,
/// The CLR token.TOKEN = 0x000C,
/// A 7-bit offset from the base of the section that contains the target.SECREL7 = 0x000D,
/// The 32-bit relative displacement to the target./// This supports the x86 relative branch and call instructions.REL32 = 0x0014,
_,
}
Intel 386 Processors The following relocation type indicators are defined for Intel 386 and compatible processors.