diff options
author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-13 15:40:01 +0100 |
---|---|---|
committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-13 15:40:01 +0100 |
commit | 7ec392eda3345606f0de75a432954b221cee82ce (patch) | |
tree | 48689f986a3c4042ec6b7704dad053f25ef898bf /src/crepe/system/System.h | |
parent | 202725f481e64c4d95e370102ab93d4f8cf4af93 (diff) |
add doxygen + check const correctness
Diffstat (limited to 'src/crepe/system/System.h')
-rw-r--r-- | src/crepe/system/System.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/crepe/system/System.h b/src/crepe/system/System.h index 3b81bef..ec4507f 100644 --- a/src/crepe/system/System.h +++ b/src/crepe/system/System.h @@ -2,8 +2,18 @@ namespace crepe { +/** + * \brief Base ECS system class + * + * This class is used as the base for all system classes. Classes derived from + * System must implement the System::update() method and copy Script::Script + * with the `using`-syntax. + */ class System { public: + /** + * \brief Process all components this system is responsible for. + */ virtual void update() = 0; public: |