diff options
author | max-001 <maxsmits21@kpnmail.nl> | 2024-11-24 11:50:16 +0100 |
---|---|---|
committer | max-001 <maxsmits21@kpnmail.nl> | 2024-11-24 11:50:16 +0100 |
commit | 5f710fedcbbf43f65e0ef1241f22e06d42cf79b9 (patch) | |
tree | 2c97cd0a635632d5a32788ae6c9f4a99c7c4e95d /src/doc/internal/system.dox | |
parent | 2052988dba049cfa2032d01ff9e6f7bb53d084fe (diff) | |
parent | 1499363d85abedbdb571e33801b821f4dfabc638 (diff) |
Merge remote-tracking branch 'origin/master' into max/scenes
Diffstat (limited to 'src/doc/internal/system.dox')
-rw-r--r-- | src/doc/internal/system.dox | 26 |
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; +}; +``` + +*/ +} |