aboutsummaryrefslogtreecommitdiff
path: root/src/doc/internal/system.dox
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-22 17:28:28 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-22 17:28:28 +0100
commit1499363d85abedbdb571e33801b821f4dfabc638 (patch)
tree32799f2e966c7c39808eb29cca85736742600c60 /src/doc/internal/system.dox
parent610461763977597c5df213d272a514730dd2364e (diff)
more documentation
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;
+};
+```
+
+*/
+}