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 Enum
AddressSpace
Public Enum
std.lang.AddressSpace
pubconstAddressSpace = enum(u5)
This data structure is used by the Zig language code generation and therefore must be kept in sync with the compiler implementation.
pubconstAddressSpace = enum(u5) {
// CPU address spaces.generic,
gs,
fs,
ss,
// x86_16 extra address spaces./// Allows addressing the entire address space by storing both segment and offset.far,
// GPU address spaces.global,
constant,
param,
shared,
local,
input,
output,
uniform,
push_constant,
storage_buffer,
physical_storage_buffer,
// AVR address spaces.flash,
flash1,
flash2,
flash3,
flash4,
flash5,
// Propeller address spaces./// This address space only addresses the cog-local ram.cog,
/// This address space only addresses shared hub ram.hub,
/// This address space only addresses the "lookup" ramlut,
// Web Assemblyexternref,
funcref,
}
This data structure is used by the Zig language code generation and therefore must be kept in sync with the compiler implementation.