Improved documentation and consistancy

src/ansi.zig

@@ -1,3 +1,7 @@
+//! ----------------------------------------------------
+//! ANSI Colors for terminal
+//! ----------------------------------------------------
+
 // --- RESET ---
 pub const reset = "\x1b[0m";
 

src/fixed_array_list.zig

@@ -1,6 +1,24 @@
+//! ----------------------------------------------------
+//! ----------------------------------------------------
+
 const std = @import("std");
 
 /// ----------------------------------------------------
+/// # Example
+///
+/// ```zig
+/// var entities: FixedArrayList(u32, 4) = .empty;
+///
+/// try entities.append(1);
+/// try entities.append(2);
+/// try entities.append(3);
+///
+/// if (entities.getPtr(0)) |v| v.* = 69;
+///
+/// for (entities.items()) |item| {
+///     std.debug.print("Entity: {}\n", .{item});
+/// }
+/// ```
 /// ----------------------------------------------------
 pub fn FixedArrayList(
     comptime T: type,

src/fixed_slot_map.zig

@@ -1,3 +1,6 @@
+//! ----------------------------------------------------
+//! ----------------------------------------------------
+
 const std = @import("std");
 const FixedArrayList = @import("fixed_array_list.zig").FixedArrayList;
 const Handle = @import("handle.zig").Handle;
@@ -6,6 +9,15 @@ const Handle = @import("handle.zig").Handle;
 /// # Example
 ///
 /// ```zig
+/// var materials: FixedSlotMap(Material, 3) = .empty;
+///
+/// _ = try materials.put(.{});
+/// _ = try materials.put(.{});
+/// const handle = try materials.put(.{ .unique = .{ .topology = .line_list } });
+///
+/// if (materials.get(handle)) |v| {
+///     std.debug.print("Material: {}\n", .{v.unique.topology});
+/// }
 /// ```
 /// ----------------------------------------------------
 pub fn FixedSlotMap(

src/gtl.zig

@@ -1,3 +1,21 @@
+//! ----------------------------------------------------
+//! # Game Template Library
+//!
+//! Low *cortisol* library for games and game engines
+//!
+//! # Features
+//!
+//! **dynamic**
+//! | SlotMap
+//! | KeyedSlotMap
+//! | Handle(T) **Generational**
+//!
+//! **fixed**
+//! | FixedArrayList
+//! | FixedSlotMap
+//! | RingBuffer
+//! ----------------------------------------------------
+
 //
 // PRIVATE
 //
@@ -106,7 +124,7 @@ test "SlotMap" {
     }
 }
 
-test "SlotMap-DEP" {
+test "SlotMap-DEP" { // TODO: Yes...
     {
         // --- LOG ---
         log.warn("...", .{}, @src());
@@ -173,7 +191,7 @@ test "SlotMap-DEP" {
 test "RingBuffer" {
     std.debug.print("{s}━━━ RING BUFFER ━━━{s}\n", .{ ansi.blue, ansi.reset });
 
-    var prev_inputs: RingBuffer([]const u8, 256) = .{};
+    var prev_inputs: RingBuffer([]const u8, 256) = .empty;
 
     try prev_inputs.push("w");
     try prev_inputs.push("s");

src/handle.zig

@@ -1,3 +1,6 @@
+/// ----------------------------------------------------
+/// Generational Handle
+/// ----------------------------------------------------
 pub fn Handle(comptime T: type) type {
     _ = T;
     return struct {

src/keyed_slot_map.zig

@@ -1,3 +1,6 @@
+//! ----------------------------------------------------
+//! ----------------------------------------------------
+
 const std = @import("std");
 const SlotMap = @import("slot_map.zig").SlotMap;
 const Handle = @import("handle.zig").Handle;

src/log.zig

@@ -1,3 +1,6 @@
+//! ----------------------------------------------------
+//! ----------------------------------------------------
+
 const std = @import("std");
 const ansi = @import("ansi.zig");
 

src/ring_buffer.zig

@@ -48,10 +48,19 @@ pub fn RingBuffer(
         // FIELDS
         //
 
-        buffers: [Capacity]T = std.mem.zeroes([Capacity]T),
-        head: usize = 0,
-        tail: usize = 0,
-        count: usize = 0,
+        buffers: [Capacity]T,
+        head: usize,
+        tail: usize,
+        count: usize,
+
+        /// ----------------------------------------------------
+        /// ----------------------------------------------------
+        pub const empty = Self{
+            .buffers = undefined,
+            .head = 0,
+            .tail = 0,
+            .count = 0,
+        };
 
         /// ----------------------------------------------------
         /// ----------------------------------------------------

src/slot_map.zig

@@ -1,3 +1,6 @@
+//! ----------------------------------------------------
+//! ----------------------------------------------------
+
 const std = @import("std");
 const Handle = @import("handle.zig").Handle;
 

src/type_id.zig

@@ -1,5 +1,11 @@
+//! ----------------------------------------------------
+//! ----------------------------------------------------
+
 const std = @import("std");
 
+/// ----------------------------------------------------
+/// Returns hash of @typeName(T)
+/// ----------------------------------------------------
 pub fn of(comptime T: type) u64 {
     return std.hash.Wyhash.hash(
         694721,