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 standard library.
std › elf › takeProgramHeader Public Function takeProgramHeader Doc Source Public Function std.elf.takeProgramHeader
pub fn takeProgramHeader (reader : *Io .Reader , is_64 : bool , endian : Endian ) !Elf64 .Phdr Params reader : *Io .Reader is_64 : bool endian : Endian File elf.zig: 843
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860 pub fn takeProgramHeader (reader : *Io .Reader , is_64 : bool , endian : Endian ) !Elf64 .Phdr {
if (is_64 ) {
const phdr = try reader .takeStruct (Elf64 .Phdr , endian );
return phdr ;
}
const phdr = try reader .takeStruct (Elf32 .Phdr , endian );
return .{
.type = phdr .type ,
.offset = phdr .offset ,
.vaddr = phdr .vaddr ,
.paddr = phdr .paddr ,
.filesz = phdr .filesz ,
.memsz = phdr .memsz ,
.flags = phdr .flags ,
.@"align" = phdr .@"align" ,
};
}