From 900c8756edc3bc547dfd2cd47921ecd453bf703b Mon Sep 17 00:00:00 2001
From: jjanzen <jjanzen@jjanzen.ca>
Date: Tue, 21 Jan 2025 23:26:23 -0600
Subject: doc comments and io refactor

---
 src/ecs/component.zig | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/ecs/component.zig')

diff --git a/src/ecs/component.zig b/src/ecs/component.zig
index 37956d0..3a50c88 100644
--- a/src/ecs/component.zig
+++ b/src/ecs/component.zig
@@ -1,5 +1,7 @@
+//! This module provides a basic component interface for an Entity Component System
 const std = @import("std");
 
+/// An empty component for testing purposes
 pub const ComponentStub = struct {
     pub fn init(args: ComponentStub) ComponentStub {
         _ = args;
@@ -11,10 +13,12 @@ pub const ComponentStub = struct {
     }
 };
 
+/// All valid component types are stored in this enum
 pub const ComponentType = enum {
     component_stub,
 };
 
+/// The components are stored as a MultiArrayList over this struct
 pub const Components = struct {
     component_stub: ?ComponentStub,
 };
-- 
cgit v1.2.3