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
MIPS
Public Enum
std.coff.IMAGE.REL.MIPS
pubconstMIPS = enum(u16)
MIPS Processors The following relocation type indicators are defined for MIPS processors.
pubconstMIPS = enum(u16) {
/// The relocation is ignored.ABSOLUTE = 0x0000,
/// The high 16 bits of the target's 32-bit VA.REFHALF = 0x0001,
/// The target's 32-bit VA.REFWORD = 0x0002,
/// The low 26 bits of the target's VA./// This supports the MIPS J and JAL instructions.JMPADDR = 0x0003,
/// The high 16 bits of the target's 32-bit VA./// This is used for the first instruction in a two-instruction sequence that loads a full address./// This relocation must be immediately followed by a PAIR relocation whose SymbolTableIndex contains a signed 16-bit displacement that is added to the upper 16 bits that are taken from the location that is being relocated.REFHI = 0x0004,
/// The low 16 bits of the target's VA.REFLO = 0x0005,
/// A 16-bit signed displacement of the target relative to the GP register.GPREL = 0x0006,
/// The same as IMAGE_REL_MIPS_GPREL.LITERAL = 0x0007,
/// The 16-bit section index of the section 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 low 16 bits of the 32-bit offset of the target from the beginning of its section.SECRELLO = 0x000C,
/// The high 16 bits of the 32-bit offset of the target from the beginning of its section./// An IMAGE_REL_MIPS_PAIR relocation must immediately follow this one./// The SymbolTableIndex of the PAIR relocation contains a signed 16-bit displacement that is added to the upper 16 bits that are taken from the location that is being relocated.SECRELHI = 0x000D,
/// The low 26 bits of the target's VA./// This supports the MIPS16 JAL instruction.JMPADDR16 = 0x0010,
/// The target's 32-bit RVA.REFWORDNB = 0x0022,
/// The relocation is valid only when it immediately follows a REFHI or SECRELHI relocation./// Its SymbolTableIndex contains a displacement and not an index into the symbol table.PAIR = 0x0025,
_,
}
MIPS Processors The following relocation type indicators are defined for MIPS processors.