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
Header
Public Struct
std.os.linux.bpf.btf.Header
pubconstHeader = externstruct
All offsets are in bytes relative to the end of this header
Fields
magic: u16
version: u8
flags: u8
hdr_len: u32
type_off: u32
offset of type section
type_len: u32
length of type section
str_off: u32
offset of string section
str_len: u32
length of string section
File
os/linux/bpf/btf.zig:9
91011121314151617181920212223242526
pubconstHeader = externstruct {
magic: u16,
version: u8,
flags: u8,
hdr_len: u32,
/// offset of type sectiontype_off: u32,
/// length of type sectiontype_len: u32,
/// offset of string sectionstr_off: u32,
/// length of string sectionstr_len: u32,
}
All offsets are in bytes relative to the end of this header