Zig 0.17.0-dev (Split by item)

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.

PT

elf.PT
pub const PT = enum(Word)

File

lib/std/elf.zig:467

Code

pub const PT = enum(Word) {
    /// Program header table entry unused
    NULL = 0,
    /// Loadable program segment
    LOAD = 1,
    /// Dynamic linking information
    DYNAMIC = 2,
    /// Program interpreter
    INTERP = 3,
    /// Auxiliary information
    NOTE = 4,
    /// Reserved
    SHLIB = 5,
    /// Entry for header table itself
    PHDR = 6,
    /// Thread-local storage segment
    TLS = 7,
    _,

    /// Number of defined types
    pub const NUM = @typeInfo(PT).@"enum".field_names.len;

    /// Start of OS-specific
    pub const LOOS: PT = @fromBackingInt(@intCast(0x60000000));
    /// End of OS-specific
    pub const HIOS: PT = @fromBackingInt(@intCast(0x6fffffff));

    /// GCC .eh_frame_hdr segment
    pub const GNU_EH_FRAME: PT = @fromBackingInt(@intCast(0x6474e550));
    /// Indicates stack executability
    pub const GNU_STACK: PT = @fromBackingInt(@intCast(0x6474e551));
    /// Read-only after relocation
    pub const GNU_RELRO: PT = @fromBackingInt(@intCast(0x6474e552));

    pub const LOSUNW: PT = @fromBackingInt(@intCast(0x6ffffffa));
    pub const HISUNW: PT = @fromBackingInt(@intCast(0x6fffffff));

    /// Sun specific segment
    pub const SUNWBSS: PT = @fromBackingInt(@intCast(0x6ffffffa));
    /// Stack segment
    pub const SUNWSTACK: PT = @fromBackingInt(@intCast(0x6ffffffb));

    /// Start of processor-specific
    pub const LOPROC: PT = @fromBackingInt(@intCast(0x70000000));
    /// End of processor-specific
    pub const HIPROC: PT = @fromBackingInt(@intCast(0x7fffffff));
}