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 Struct
Header32
Public Struct
std.elf.hash.Header32
pubconstHeader32 = externstruct
The header of a SHT.HASH section on most architectures. Immediately followed by:
buckets: [nbucket]u32
chains: [nchain]u32
The bucket for a symbol named name is std.elf.hash.calculate(name) % nbuckets.
buckets[b] is the index of the first symbol in bucket b. If bucket b is empty then the value is 0 (STN_UNDEF).
chain[sym_index] is the index of the next symbol in the same bucket as sym_index. If sym_index is the last symbol in its bucket then the value is 0 (STN_UNDEF).
The header of a
SHT.HASHsection on most architectures. Immediately followed by:buckets: [nbucket]u32chains: [nchain]u32The bucket for a symbol named
nameisstd.elf.hash.calculate(name) % nbuckets.buckets[b]is the index of the first symbol in bucketb. If bucketbis empty then the value is 0 (STN_UNDEF).chain[sym_index]is the index of the next symbol in the same bucket assym_index. Ifsym_indexis the last symbol in its bucket then the value is 0 (STN_UNDEF).See also
Header64.