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.

STT

elf.STT
pub const STT = enum(u4)

File

lib/std/elf.zig:616

Code

pub const STT = enum(u4) {
    /// Symbol type is unspecified
    NOTYPE = 0,
    /// Symbol is a data object
    OBJECT = 1,
    /// Symbol is a code object
    FUNC = 2,
    /// Symbol associated with a section
    SECTION = 3,
    /// Symbol's name is file name
    FILE = 4,
    /// Symbol is a common data object
    COMMON = 5,
    /// Symbol is thread-local data object
    TLS = 6,
    _,

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

    /// Start of OS-specific
    pub const LOOS: STT = @fromBackingInt(@intCast(10));
    /// End of OS-specific
    pub const HIOS: STT = @fromBackingInt(@intCast(12));

    /// Symbol is indirect code object
    pub const GNU_IFUNC: STT = @fromBackingInt(@intCast(@backingInt(LOOS) + 0));

    pub const HP_OPAQUE: STT = @fromBackingInt(@intCast(@backingInt(LOOS) + 1));
    pub const HP_STUB: STT = @fromBackingInt(@intCast(@backingInt(LOOS) + 2));

    /// Start of processor-specific
    pub const LOPROC: STT = @fromBackingInt(@intCast(13));
    /// End of processor-specific
    pub const HIPROC: STT = @fromBackingInt(@intCast(15));

    pub const SPARC_REGISTER: STT = @fromBackingInt(@intCast(@backingInt(LOPROC) + 0));

    pub const PARISC_MILLICODE: STT = @fromBackingInt(@intCast(@backingInt(LOPROC) + 0));

    pub const ARM_TFUNC: STT = @fromBackingInt(@intCast(@backingInt(LOPROC) + 0));
    pub const ARM_16BIT: STT = @fromBackingInt(@intCast(@backingInt(HIPROC) + 2));
}