aboutsummaryrefslogtreecommitdiff
path: root/src/doc/internal/system.dox
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-25 18:11:32 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-25 18:11:32 +0100
commit92e3fbda73128e65a31b3760b3fa4bd0147debe3 (patch)
tree40a2c43f0de4a0557074c69d1f8eafb5d7b61d3e /src/doc/internal/system.dox
parentd038f192c7dcb453c9fc19082cd1b642c8f70fc8 (diff)
parentbe5ccbe24086d5d4fb407f268c649dcbc36eda6b (diff)
merge `master`
Diffstat (limited to 'src/doc/internal/system.dox')
-rw-r--r--src/doc/internal/system.dox26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/doc/internal/system.dox b/src/doc/internal/system.dox
new file mode 100644
index 0000000..17a101e
--- /dev/null
+++ b/src/doc/internal/system.dox
@@ -0,0 +1,26 @@
+// vim:ft=doxygen
+namespace crepe {
+/**
+
+\defgroup internal_system Systems
+\ingroup internal
+\brief ECS Systems
+
+\todo This section is incomplete
+
+A system is responsible for processing the data stored in \ref
+internal_component "components".
+
+A basic system has the following structure:
+```cpp
+#include <crepe/system/System.h>
+
+class MySystem : public System {
+public:
+ using System::System;
+ void update() override;
+};
+```
+
+*/
+}