diff options
author | JAROWMR <jarorutjes07@gmail.com> | 2024-11-23 22:19:43 +0100 |
---|---|---|
committer | JAROWMR <jarorutjes07@gmail.com> | 2024-11-23 22:19:43 +0100 |
commit | 31e57c515519e53f25cf47c859dc19fef4fe533c (patch) | |
tree | 3f2408ea3954c6aaeedd040258bde5c7369a639d /src/doc/internal/system.dox | |
parent | 08a3171b6bcc9a36ad89f04d2cdae406eb366a96 (diff) | |
parent | 1499363d85abedbdb571e33801b821f4dfabc638 (diff) |
Merge branch 'master' of github.com:lonkaars/crepe into jaro/collision-system
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; +}; +``` + +*/ +} |