authorgravatar for r00ster91@proton.meWooster <r00ster91@proton.me> 2023-09-08 20:59:25+02:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2023-09-08 21:59:25+03:00
logf33bb0228b40a1171fafad40415bd5744e617e21
treed2fffe1a7ac82121e611e9bbd37d29a139045fa7
parent39a98dc4261cf6106954aae1570fe1861311ff08
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

std: clean up top-level namespaces documentation

This cleans up existing documentation, adds a bit more, and fixes some typos too.

1 files changed, 31 insertions(+), 18 deletions(-)

lib/std/std.zig+31-18
...@@ -54,19 +54,21 @@ pub const Uri = @import("Uri.zig");...@@ -54,19 +54,21 @@ pub const Uri = @import("Uri.zig");
5454
55pub const array_hash_map = @import("array_hash_map.zig");55pub const array_hash_map = @import("array_hash_map.zig");
5656
57/// Memory ordering, atomic data structures and operations.57/// Memory ordering, atomic data structures, and operations.
58pub const atomic = @import("atomic.zig");58pub const atomic = @import("atomic.zig");
5959
60/// Base64 encoding / decoding.60/// Base64 encoding/decoding.
61pub const base64 = @import("base64.zig");61pub const base64 = @import("base64.zig");
6262
63/// Bit-fiddling data structures.63/// Bit manipulation data structures.
64pub const bit_set = @import("bit_set.zig");64pub const bit_set = @import("bit_set.zig");
6565
66/// Comptime-available information about the target machine and build mode.66/// Comptime-available information about the build environment, such as the target and optimize mode.
67pub const builtin = @import("builtin.zig");67pub const builtin = @import("builtin.zig");
6868
69pub const c = @import("c.zig");69pub const c = @import("c.zig");
70
71/// COFF format.
70pub const coff = @import("coff.zig");72pub const coff = @import("coff.zig");
7173
72/// Compression algorithms such as zlib, zstd, etc.74/// Compression algorithms such as zlib, zstd, etc.
...@@ -79,7 +81,11 @@ pub const cstr = @import("cstr.zig");...@@ -79,7 +81,11 @@ pub const cstr = @import("cstr.zig");
7981
80/// Debug printing, allocation and other debug helpers.82/// Debug printing, allocation and other debug helpers.
81pub const debug = @import("debug.zig");83pub const debug = @import("debug.zig");
84
85/// DWARF debugging data format.
82pub const dwarf = @import("dwarf.zig");86pub const dwarf = @import("dwarf.zig");
87
88/// ELF format.
83pub const elf = @import("elf.zig");89pub const elf = @import("elf.zig");
8490
85/// Enum-related metaprogramming helpers.91/// Enum-related metaprogramming helpers.
...@@ -88,15 +94,16 @@ pub const enums = @import("enums.zig");...@@ -88,15 +94,16 @@ pub const enums = @import("enums.zig");
88/// Evented I/O data structures.94/// Evented I/O data structures.
89pub const event = @import("event.zig");95pub const event = @import("event.zig");
9096
97/// First in, first out data structures.
91pub const fifo = @import("fifo.zig");98pub const fifo = @import("fifo.zig");
9299
93/// String formatting and parsing (eg parsing numbers out of strings).100/// String formatting and parsing (e.g. parsing numbers out of strings).
94pub const fmt = @import("fmt.zig");101pub const fmt = @import("fmt.zig");
95102
96/// File-system related types.103/// File system-related functionality.
97pub const fs = @import("fs.zig");104pub const fs = @import("fs.zig");
98105
99/// Fast hashing functions (i.e. not cryptographically secure)106/// Fast hashing functions (i.e. not cryptographically secure).
100pub const hash = @import("hash.zig");107pub const hash = @import("hash.zig");
101pub const hash_map = @import("hash_map.zig");108pub const hash_map = @import("hash_map.zig");
102109
...@@ -106,21 +113,25 @@ pub const heap = @import("heap.zig");...@@ -106,21 +113,25 @@ pub const heap = @import("heap.zig");
106/// HTTP client and server.113/// HTTP client and server.
107pub const http = @import("http.zig");114pub const http = @import("http.zig");
108115
109/// I/O Streams, Reader/Writer interfaces and common helpers.116/// I/O streams, reader/writer interfaces and common helpers.
110pub const io = @import("io.zig");117pub const io = @import("io.zig");
111118
112/// JSON parsing and serialization.119/// JSON parsing and serialization.
113pub const json = @import("json.zig");120pub const json = @import("json.zig");
121
122/// LEB128 encoding.
114pub const leb = @import("leb128.zig");123pub const leb = @import("leb128.zig");
115124
116/// A standardized interface for logging.125/// A standardized interface for logging.
117pub const log = @import("log.zig");126pub const log = @import("log.zig");
127
128/// Mach-O format.
118pub const macho = @import("macho.zig");129pub const macho = @import("macho.zig");
119130
120/// Mathematical constants and operations.131/// Mathematical constants and operations.
121pub const math = @import("math.zig");132pub const math = @import("math.zig");
122133
123/// Functions for comparing, searching and manipulating memory.134/// Functions for comparing, searching, and manipulating memory.
124pub const mem = @import("mem.zig");135pub const mem = @import("mem.zig");
125136
126/// Metaprogramming helpers.137/// Metaprogramming helpers.
...@@ -137,13 +148,14 @@ pub const once = @import("once.zig").once;...@@ -137,13 +148,14 @@ pub const once = @import("once.zig").once;
137/// A set of array and slice types that bit-pack integer elements.148/// A set of array and slice types that bit-pack integer elements.
138pub const packed_int_array = @import("packed_int_array.zig");149pub const packed_int_array = @import("packed_int_array.zig");
139150
151/// PDB file format.
140pub const pdb = @import("pdb.zig");152pub const pdb = @import("pdb.zig");
141153
142/// Accessors for process-related info (e.g. command line arguments)154/// Accessors for process-related info (e.g. command line arguments)
143/// aand spawning of child processes.155/// and spawning of child processes.
144pub const process = @import("process.zig");156pub const process = @import("process.zig");
145157
146/// Fast pseudo-random number generators (i.e. non-cryptographically secure).158/// Fast pseudo-random number generators (i.e. not cryptographically secure).
147pub const rand = @import("rand.zig");159pub const rand = @import("rand.zig");
148160
149/// Sorting.161/// Sorting.
...@@ -152,32 +164,33 @@ pub const sort = @import("sort.zig");...@@ -152,32 +164,33 @@ pub const sort = @import("sort.zig");
152/// Single Instruction Multiple Data (SIMD) helpers.164/// Single Instruction Multiple Data (SIMD) helpers.
153pub const simd = @import("simd.zig");165pub const simd = @import("simd.zig");
154166
155/// ASCII text manipulation.167/// ASCII text processing.
156pub const ascii = @import("ascii.zig");168pub const ascii = @import("ascii.zig");
157169
158/// Tar archive format compression / decompression.170/// Tar archive format compression/decompression.
159pub const tar = @import("tar.zig");171pub const tar = @import("tar.zig");
160172
161/// Testing allocator, testing assertions, and other helpers for testing code.173/// Testing allocator, testing assertions, and other helpers for testing code.
162pub const testing = @import("testing.zig");174pub const testing = @import("testing.zig");
163175
164/// Sleep, obtaining the current time and constants for conversions.176/// Sleep, obtaining the current time, conversion constants, and more.
165pub const time = @import("time.zig");177pub const time = @import("time.zig");
166178
167/// Timezones.179/// Time zones.
168pub const tz = @import("tz.zig");180pub const tz = @import("tz.zig");
169181
170/// UTF8 and UTF16LE ecoding / decoding.182/// UTF-8 and UTF-16LE encoding/decoding.
171pub const unicode = @import("unicode.zig");183pub const unicode = @import("unicode.zig");
172184
173/// Helpers for integrating with Valgrind.185/// Helpers for integrating with Valgrind.
174pub const valgrind = @import("valgrind.zig");186pub const valgrind = @import("valgrind.zig");
175187
176/// Constants and types representing the WASM binary format.188/// Constants and types representing the Wasm binary format.
177pub const wasm = @import("wasm.zig");189pub const wasm = @import("wasm.zig");
178190
179/// Tokenizing and parsing of Zig code and other Zig-specific language tooling.191/// Tokenizing and parsing of Zig code and other Zig-specific language tooling.
180pub const zig = @import("zig.zig");192pub const zig = @import("zig.zig");
193
181pub const start = @import("start.zig");194pub const start = @import("start.zig");
182195
183/// deprecated: use `Build`.196/// deprecated: use `Build`.
...@@ -193,7 +206,7 @@ pub const options = struct {...@@ -193,7 +206,7 @@ pub const options = struct {
193 else206 else
194 debug.default_enable_segfault_handler;207 debug.default_enable_segfault_handler;
195208
196 /// Function used to implement std.fs.cwd for wasi.209 /// Function used to implement `std.fs.cwd` for WASI.
197 pub const wasiCwd: fn () fs.Dir = if (@hasDecl(options_override, "wasiCwd"))210 pub const wasiCwd: fn () fs.Dir = if (@hasDecl(options_override, "wasiCwd"))
198 options_override.wasiCwd211 options_override.wasiCwd
199 else212 else