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.
Zig
Index
build-web/
build-web/
fuzz.zig
main.zig
time_report.zig
c/
c/
stdlib/
stdlib/
drand48.zig
rand.zig
sys/
sys/
capability.zig
file.zig
mman.zig
reboot.zig
utsname.zig
ctype.zig
fcntl.zig
inttypes.zig
malloc.zig
math.zig
pthread.zig
search.zig
stdlib.zig
string.zig
strings.zig
stropts.zig
unistd.zig
wchar.zig
compiler/
compiler/
Maker/
Maker/
Fetch/
Fetch/
git.zig
Package/
Package/
Manifest.zig
Step/
Step/
CheckFile.zig
Compile.zig
ConfigHeader.zig
FindProgram.zig
Fmt.zig
InstallArtifact.zig
InstallDir.zig
InstallFile.zig
ObjCopy.zig
Options.zig
Run.zig
TranslateC.zig
UpdateSourceFiles.zig
WriteFile.zig
Watch/
Watch/
FsEvents.zig
Fetch.zig
Fuzz.zig
Graph.zig
Package.zig
PkgConfig.zig
ScannedConfig.zig
Step.zig
Watch.zig
WebServer.zig
aro/
aro/
aro/
aro/
Attribute/
Attribute/
names.zig
Builtins/
Builtins/
TypeDescription.zig
aarch64.zig
amdgcn.zig
arm.zig
bpf.zig
common.zig
eval.zig
hexagon.zig
loongarch.zig
mips.zig
nvptx.zig
powerpc.zig
properties.zig
riscv.zig
s390x.zig
ve.zig
x86.zig
x86_64.zig
xcore.zig
Driver/
Driver/
Distro.zig
GCCDetector.zig
GCCVersion.zig
Multilib.zig
Parser/
Parser/
Diagnostic.zig
Preprocessor/
Preprocessor/
Diagnostic.zig
Tree/
Tree/
number_affixes.zig
char_info/
char_info/
identifier_tables.zig
pragmas/
pragmas/
gcc.zig
message.zig
once.zig
pack.zig
Attribute.zig
Builtins.zig
CodeGen.zig
Compilation.zig
DepFile.zig
Diagnostics.zig
Driver.zig
Hideset.zig
InitList.zig
LangOpts.zig
Parser.zig
Pragma.zig
Preprocessor.zig
Source.zig
StringInterner.zig
SymbolStack.zig
Target.zig
Tokenizer.zig
Toolchain.zig
Tree.zig
TypeStore.zig
Value.zig
annex_g.zig
char_info.zig
features.zig
record_layout.zig
text_literal.zig
tracy.zig
assembly_backend/
assembly_backend/
x86_64.zig
backend/
backend/
Ir/
Ir/
x86/
x86/
Renderer.zig
Object/
Object/
Elf.zig
Assembly.zig
CodeGenOptions.zig
Interner.zig
Ir.zig
Object.zig
aro.zig
assembly_backend.zig
backend.zig
main.zig
reduce/
reduce/
Walk.zig
resinator/
resinator/
ani.zig
ast.zig
bmp.zig
cli.zig
code_pages.zig
comments.zig
compile.zig
cvtres.zig
disjoint_code_page.zig
errors.zig
ico.zig
lang.zig
lex.zig
literals.zig
main.zig
parse.zig
preprocess.zig
rc.zig
res.zig
source_mapping.zig
utils.zig
windows1252.zig
translate-c/
translate-c/
MacroTranslator.zig
PatternList.zig
Scope.zig
Translator.zig
ast.zig
builtins.zig
helpers.zig
main.zig
Maker.zig
configurer.zig
objcopy.zig
objdump.zig
reduce.zig
std-docs.zig
test_runner.zig
util.zig
compiler_rt/
compiler_rt/
aarch64_outline_atomics.zig
absv.zig
absvdi2.zig
absvdi2_test.zig
absvsi2.zig
absvsi2_test.zig
absvti2.zig
absvti2_test.zig
adddf3.zig
addf3.zig
addf3_test.zig
addhf3.zig
addsf3.zig
addtf3.zig
addvdi3.zig
addvsi3.zig
addxf3.zig
arm.zig
atomics.zig
aulldiv.zig
aullrem.zig
bitreverse.zig
bitreversedi2_test.zig
bitreversesi2_test.zig
bitreverseti2_test.zig
bswap.zig
bswapdi2_test.zig
bswapsi2_test.zig
bswapti2_test.zig
clear_cache.zig
clzdi2_test.zig
clzsi2_test.zig
clzti2_test.zig
cmp.zig
cmpdf2.zig
cmpdi2_test.zig
cmpsi2_test.zig
cmptf2.zig
cmpti2_test.zig
cmpxf2.zig
comparedf2_test.zig
comparef.zig
comparesf2_test.zig
cos.zig
count0bits.zig
ctzdi2_test.zig
ctzsi2_test.zig
ctzti2_test.zig
divc3.zig
divc3_test.zig
divdc3.zig
divdf3.zig
divdf3_test.zig
divhc3.zig
divhf3.zig
divmodei4.zig
divsc3.zig
divsf3.zig
divsf3_test.zig
divtc3.zig
divtf3.zig
divtf3_test.zig
divti3_test.zig
divxc3.zig
divxf3.zig
divxf3_test.zig
emutls.zig
exp.zig
exp2.zig
exp_f128.zig
extenddftf2.zig
extenddfxf2.zig
extendf.zig
extendf_test.zig
extendhfdf2.zig
extendhfsf2.zig
extendhftf2.zig
extendhfxf2.zig
extendsfdf2.zig
extendsftf2.zig
extendsfxf2.zig
extendxftf2.zig
fabs.zig
ffsdi2_test.zig
ffssi2_test.zig
ffsti2_test.zig
fixdfdi.zig
fixdfei.zig
fixdfsi.zig
fixdfti.zig
fixhfei.zig
fixint_test.zig
fixsfdi.zig
fixsfei.zig
fixsfsi.zig
fixsfti.zig
fixtfdi.zig
fixtfei.zig
fixtfsi.zig
fixtfti.zig
fixunsdfdi.zig
fixunsdfei.zig
fixunsdfsi.zig
fixunsdfti.zig
fixunshfdi.zig
fixunshfei.zig
fixunshfsi.zig
fixunshfti.zig
fixunssfdi.zig
fixunssfei.zig
fixunssfsi.zig
fixunssfti.zig
fixunstfdi.zig
fixunstfei.zig
fixunstfsi.zig
fixunstfti.zig
fixunsxfdi.zig
fixunsxfei.zig
fixunsxfsi.zig
fixunsxfti.zig
fixxfdi.zig
fixxfei.zig
fixxfsi.zig
float_from_int.zig
float_from_int_test.zig
floatdidf.zig
floatdihf.zig
floatdisf.zig
floatditf.zig
floatdixf.zig
floateidf.zig
floateihf.zig
floateisf.zig
floateitf.zig
floateixf.zig
floatsidf.zig
floatsihf.zig
floatsisf.zig
floatsitf.zig
floatsixf.zig
floattidf.zig
floattihf.zig
floattisf.zig
floattitf.zig
floattixf.zig
floatundidf.zig
floatundihf.zig
floatundisf.zig
floatunditf.zig
floatundixf.zig
floatuneidf.zig
floatuneihf.zig
floatuneisf.zig
floatuneitf.zig
floatuneixf.zig
floatunsidf.zig
floatunsihf.zig
floatunsisf.zig
floatunsitf.zig
floatunsixf.zig
floatuntidf.zig
floatuntihf.zig
floatuntisf.zig
floatuntitf.zig
floatuntixf.zig
floor_ceil.zig
fma.zig
fmax.zig
fmin.zig
fmod.zig
fmodq_test.zig
fmodx_test.zig
gedf2.zig
gehf2.zig
gesf2.zig
getf2.zig
gexf2.zig
hexagon.zig
int.zig
int_from_float.zig
int_from_float_test.zig
limb64.zig
log.zig
log10.zig
log2.zig
log_f128.zig
memcpy.zig
memmove.zig
modti3_test.zig
mulXi3.zig
mulXi3_test.zig
mulc3.zig
mulc3_test.zig
muldc3.zig
muldf3.zig
mulf3.zig
mulf3_test.zig
mulhc3.zig
mulhf3.zig
mulo.zig
mulodi4_test.zig
mulosi4_test.zig
muloti4_test.zig
mulsc3.zig
mulsf3.zig
multc3.zig
multf3.zig
mulvsi3.zig
mulxc3.zig
mulxf3.zig
negdi2_test.zig
negsi2_test.zig
negti2_test.zig
negv.zig
negvdi2_test.zig
negvsi2_test.zig
negvti2_test.zig
os_version_check.zig
parity.zig
paritydi2_test.zig
paritysi2_test.zig
parityti2_test.zig
popcount.zig
popcountdi2_test.zig
popcountsi2_test.zig
popcountti2_test.zig
powiXf2.zig
powiXf2_test.zig
rem_pio2.zig
rem_pio2_large.zig
rem_pio2f.zig
rem_pio2l.zig
round.zig
shift.zig
shift_test.zig
sin.zig
sincos.zig
sqrt.zig
ssp.zig
stack_probe.zig
subdf3.zig
subhf3.zig
subsf3.zig
subtf3.zig
subvdi3.zig
subvsi3.zig
subxf3.zig
tan.zig
trig.zig
trunc.zig
truncdfhf2.zig
truncdfsf2.zig
truncf.zig
truncf_test.zig
truncsfhf2.zig
trunctfdf2.zig
trunctfhf2.zig
trunctfsf2.zig
trunctfxf2.zig
truncxfdf2.zig
truncxfhf2.zig
truncxfsf2.zig
ucmpdi2_test.zig
ucmpsi2_test.zig
ucmpti2_test.zig
udivmod.zig
udivmoddi4_test.zig
udivmodei4.zig
udivmodsi4_test.zig
udivmodti4_test.zig
unorddf2.zig
docs/
docs/
wasm/
wasm/
markdown/
markdown/
Document.zig
Parser.zig
renderer.zig
Decl.zig
Walk.zig
html_render.zig
main.zig
markdown.zig
init/
init/
src/
src/
main.zig
root.zig
build.zig
std/
std/
Build/
Build/
Cache/
Cache/
DepTokenizer.zig
Directory.zig
Path.zig
Step/
Step/
CheckFile.zig
Compile.zig
ConfigHeader.zig
Fail.zig
FindProgram.zig
Fmt.zig
InstallArtifact.zig
InstallDir.zig
InstallFile.zig
ObjCopy.zig
Options.zig
Run.zig
TranslateC.zig
UpdateSourceFiles.zig
WriteFile.zig
Cache.zig
Configuration.zig
Module.zig
Serialize.zig
Step.zig
abi.zig
Io/
Io/
File/
File/
Atomic.zig
MemoryMap.zig
MultiReader.zig
Reader.zig
Writer.zig
Reader/
Reader/
Limited.zig
Threaded/
Threaded/
test.zig
net/
net/
HostName.zig
test.zig
Dir.zig
Dispatch.zig
File.zig
Kqueue.zig
Reader.zig
RwLock.zig
Semaphore.zig
Terminal.zig
Threaded.zig
Uring.zig
Writer.zig
fiber.zig
net.zig
test.zig
Random/
Random/
Ascon.zig
ChaCha.zig
Isaac64.zig
Pcg.zig
RomuTrio.zig
Sfc64.zig
SplitMix64.zig
Xoroshiro128.zig
Xoshiro256.zig
benchmark.zig
lcg.zig
test.zig
ziggurat.zig
Target/
Target/
Query.zig
aarch64.zig
alpha.zig
amdgcn.zig
arc.zig
arm.zig
avr.zig
bpf.zig
csky.zig
generic.zig
hexagon.zig
hppa.zig
kvx.zig
lanai.zig
loongarch.zig
m68k.zig
mips.zig
msp430.zig
nvptx.zig
powerpc.zig
propeller.zig
riscv.zig
s390x.zig
sparc.zig
spirv.zig
ve.zig
wasm.zig
x86.zig
xcore.zig
xtensa.zig
c/
c/
darwin/
darwin/
dispatch.zig
darwin.zig
dragonfly.zig
freebsd.zig
haiku.zig
illumos.zig
netbsd.zig
openbsd.zig
serenity.zig
compress/
compress/
flate/
flate/
Compress.zig
Decompress.zig
token.zig
lzma/
lzma/
test.zig
xz/
xz/
Decompress.zig
test.zig
zstd/
zstd/
Decompress.zig
flate.zig
lzma.zig
lzma2.zig
xz.zig
zstd.zig
crypto/
crypto/
25519/
25519/
curve25519.zig
ed25519.zig
edwards25519.zig
field.zig
ristretto255.zig
scalar.zig
x25519.zig
Certificate/
Certificate/
Bundle/
Bundle/
macos.zig
Bundle.zig
Chain.zig
aes/
aes/
aesni.zig
armcrypto.zig
soft.zig
codecs/
codecs/
asn1/
asn1/
der/
der/
ArrayListReverse.zig
Decoder.zig
Encoder.zig
Oid.zig
der.zig
test.zig
asn1.zig
base64_hex_ct.zig
pcurves/
pcurves/
p256/
p256/
field.zig
p256_64.zig
p256_scalar_64.zig
scalar.zig
p384/
p384/
field.zig
p384_64.zig
p384_scalar_64.zig
scalar.zig
secp256k1/
secp256k1/
field.zig
scalar.zig
secp256k1_64.zig
secp256k1_scalar_64.zig
tests/
tests/
p256.zig
p384.zig
secp256k1.zig
common.zig
p256.zig
p384.zig
secp256k1.zig
tls/
tls/
Client.zig
Certificate.zig
Sha1.zig
aegis.zig
aes.zig
aes_ccm.zig
aes_gcm.zig
aes_gcm_siv.zig
aes_ocb.zig
aes_siv.zig
argon2.zig
ascon.zig
bcrypt.zig
benchmark.zig
blake2.zig
blake3.zig
cbc_mac.zig
chacha20.zig
cmac.zig
codecs.zig
ecdsa.zig
errors.zig
ff.zig
ghash_polyval.zig
hash_composition.zig
hkdf.zig
hmac.zig
hybrid_kem.zig
isap.zig
kangarootwelve.zig
keccak_p.zig
md5.zig
ml_dsa.zig
ml_kem.zig
modes.zig
pbkdf2.zig
phc_encoding.zig
poly1305.zig
salsa20.zig
scrypt.zig
sha2.zig
sha3.zig
siphash.zig
test.zig
timing_safe.zig
tls.zig
debug/
debug/
Dwarf/
Dwarf/
Unwind/
Unwind/
VirtualMachine.zig
SelfUnwinder.zig
Unwind.zig
expression.zig
SelfInfo/
SelfInfo/
Elf.zig
MachO.zig
Windows.zig
Coverage.zig
Dwarf.zig
ElfFile.zig
Info.zig
MachOFile.zig
Pdb.zig
cpu_context.zig
no_panic.zig
simple_panic.zig
dwarf/
dwarf/
AT.zig
ATE.zig
EH.zig
FORM.zig
LANG.zig
OP.zig
TAG.zig
fmt/
fmt/
parse_float/
parse_float/
FloatInfo.zig
FloatStream.zig
common.zig
convert_eisel_lemire.zig
convert_fast.zig
convert_hex.zig
convert_slow.zig
decimal.zig
parse.zig
float.zig
parse_float.zig
fs/
fs/
path.zig
test.zig
hash/
hash/
crc/
crc/
Crc32c.zig
test.zig
Adler32.zig
auto_hash.zig
benchmark.zig
cityhash.zig
crc.zig
fnv.zig
murmur.zig
verify.zig
wyhash.zig
xxhash.zig
heap/
heap/
ArenaAllocator.zig
BrkAllocator.zig
BufferFirstAllocator.zig
FixedBufferAllocator.zig
PageAllocator.zig
SafeAllocator.zig
SmpAllocator.zig
debug_allocator.zig
memory_pool.zig
http/
http/
ChunkParser.zig
Client.zig
HeadParser.zig
HeaderIterator.zig
Server.zig
test.zig
json/
json/
JSONTestSuite_test.zig
Scanner.zig
Stringify.zig
dynamic.zig
dynamic_test.zig
hashmap.zig
hashmap_test.zig
scanner_test.zig
static.zig
static_test.zig
test.zig
lang/
lang/
assembly.zig
math/
math/
big/
big/
int.zig
int_test.zig
complex/
complex/
abs.zig
acos.zig
acosh.zig
arg.zig
asin.zig
asinh.zig
atan.zig
atanh.zig
conj.zig
cos.zig
cosh.zig
exp.zig
ldexp.zig
log.zig
pow.zig
proj.zig
sin.zig
sinh.zig
sqrt.zig
tan.zig
tanh.zig
acos.zig
acosh.zig
asin.zig
asinh.zig
atan.zig
atan2.zig
atanh.zig
big.zig
cbrt.zig
complex.zig
copysign.zig
cosh.zig
expm1.zig
expo2.zig
float.zig
frexp.zig
gamma.zig
gcd.zig
hypot.zig
ilogb.zig
isfinite.zig
isinf.zig
isnan.zig
isnormal.zig
iszero.zig
lcm.zig
ldexp.zig
log.zig
log10.zig
log1p.zig
log2.zig
log_int.zig
modf.zig
nextafter.zig
pow.zig
powi.zig
scalbn.zig
signbit.zig
sinh.zig
sqrt.zig
tanh.zig
mem/
mem/
Allocator.zig
meta/
meta/
trailer_flags.zig
os/
os/
linux/
linux/
IoUring/
IoUring/
test.zig
bpf/
bpf/
btf.zig
btf_ext.zig
helpers.zig
kern.zig
IoUring.zig
aarch64.zig
alpha.zig
arc.zig
arm.zig
bpf.zig
csky.zig
hexagon.zig
io_uring_sqe.zig
ioctl.zig
loongarch32.zig
loongarch64.zig
m68k.zig
microblaze.zig
mips.zig
mips64.zig
mipsn32.zig
or1k.zig
powerpc.zig
powerpc64.zig
riscv32.zig
riscv64.zig
s390x.zig
seccomp.zig
sh.zig
sparc.zig
sparc64.zig
syscalls.zig
test.zig
thumb.zig
tls.zig
vdso.zig
x32.zig
x86.zig
x86_64.zig
xtensa.zig
plan9/
plan9/
x86_64.zig
uefi/
uefi/
protocol/
protocol/
absolute_pointer.zig
block_io.zig
device_path.zig
edid.zig
file.zig
graphics_output.zig
hii_database.zig
hii_popup.zig
ip6.zig
ip6_config.zig
loaded_image.zig
managed_network.zig
rng.zig
serial_io.zig
service_binding.zig
shell_parameters.zig
simple_file_system.zig
simple_network.zig
simple_pointer.zig
simple_text_input.zig
simple_text_input_ex.zig
simple_text_output.zig
udp6.zig
tables/
tables/
boot_services.zig
configuration_table.zig
runtime_services.zig
system_table.zig
table_header.zig
device_path.zig
hii.zig
pool_allocator.zig
protocol.zig
status.zig
tables.zig
windows/
windows/
crypt32.zig
kernel32.zig
lang.zig
nls.zig
ntdll.zig
ntstatus.zig
sublang.zig
tls.zig
win32error.zig
ws2_32.zig
emscripten.zig
linux.zig
plan9.zig
uefi.zig
wasi.zig
windows.zig
posix/
posix/
test.zig
process/
process/
Args.zig
Child.zig
Environ.zig
Preopens.zig
sort/
sort/
block.zig
pdq.zig
tar/
tar/
Writer.zig
test.zig
testing/
testing/
FailingAllocator.zig
Smith.zig
time/
time/
epoch.zig
unicode/
unicode/
throughput_test.zig
valgrind/
valgrind/
cachegrind.zig
callgrind.zig
memcheck.zig
zig/
zig/
Ast/
Ast/
Render.zig
c_translation/
c_translation/
builtins.zig
helpers.zig
llvm/
llvm/
BitcodeReader.zig
Builder.zig
bitcode_writer.zig
ir.zig
system/
system/
darwin/
darwin/
macos.zig
NativePaths.zig
arm.zig
darwin.zig
linux.zig
loongarch.zig
windows.zig
x86.zig
Ast.zig
AstGen.zig
AstRlAnnotate.zig
BuiltinFn.zig
Client.zig
ErrorBundle.zig
LibCDirs.zig
LibCInstallation.zig
Parse.zig
PkgConfig.zig
Server.zig
TokenSmith.zig
WindowsSdk.zig
Zir.zig
Zoir.zig
ZonGen.zig
llvm.zig
number_literal.zig
parser_fuzz.zig
parser_generated_oracle.zig
parser_test.zig
perf_test.zig
primitives.zig
string_literal.zig
system.zig
target.zig
tokenizer.zig
zon/
zon/
Serializer.zig
parse.zig
stringify.zig
BitStack.zig
Build.zig
DoublyLinkedList.zig
Io.zig
Progress.zig
Random.zig
SemanticVersion.zig
SinglyLinkedList.zig
Target.zig
Thread.zig
Uri.zig
array_hash_map.zig
array_list.zig
ascii.zig
atomic.zig
base64.zig
bit_set.zig
buf_map.zig
buf_set.zig
c.zig
coff.zig
compress.zig
crypto.zig
debug.zig
deque.zig
dwarf.zig
dynamic_library.zig
elf.zig
enums.zig
fmt.zig
fs.zig
hash.zig
hash_map.zig
heap.zig
http.zig
json.zig
lang.zig
leb128.zig
log.zig
macho.zig
math.zig
mem.zig
meta.zig
multi_array_list.zig
os.zig
pdb.zig
pie.zig
posix.zig
priority_dequeue.zig
priority_queue.zig
process.zig
simd.zig
sort.zig
spirv.zig
start.zig
static_string_map.zig
std.zig
tar.zig
testing.zig
time.zig
treap.zig
tz.zig
unicode.zig
valgrind.zig
wasm.zig
zig.zig
zip.zig
zon.zig
c.zig
compiler_rt.zig
fuzzer.zig
ubsan_rt.zig