diff --git a/sources/Component/Collision/CollisionComponent.hpp b/sources/Component/Collision/CollisionComponent.hpp index a4e54265..54f7bfa4 100644 --- a/sources/Component/Collision/CollisionComponent.hpp +++ b/sources/Component/Collision/CollisionComponent.hpp @@ -14,6 +14,7 @@ namespace BBM class CollisionComponent : public WAL::Component { private: + //! @brief Bound size on all axis Vector3f _bound; public: //! @brief get bound size on the X axis @@ -28,7 +29,7 @@ namespace BBM void setBoundY(float); //! @brief set bound size on the Z axis void setBoundZ(float); - //onCollide functions to be called + //! @brief onCollide functions to be called WAL::Callback onCollide; //! @inherit WAL::Component *clone(WAL::Entity &entity) const override; @@ -39,13 +40,13 @@ namespace BBM //! @brief Constructor with a callback function CollisionComponent(WAL::Entity &entity, std::function callback, Vector3f bound); - //! @brief Constructor with a callback function + //! @brief Constructor with a callback function, same boundSize for all axis CollisionComponent(WAL::Entity &entity, std::function callback, float boundSize = 0); //! @brief Constructor with a WAL::Callback CollisionComponent(WAL::Entity &entity, WAL::Callback callback, Vector3f bound); - //! @brief Constructor with a WAL::Callback + //! @brief Constructor with a WAL::Callback, same boundSize for all axis CollisionComponent(WAL::Entity &entity, WAL::Callback callback, float boundSize = 0); //! @brief Constructor of collider with no callback @@ -54,7 +55,7 @@ namespace BBM //! @brief Constructor no callback, same boundSize for all axis CollisionComponent(WAL::Entity &entity, float boundSize); - //! @brief A component can't be instantiated, it should be derived. + //! @brief Default copy constructor CollisionComponent(const CollisionComponent &) = default; //! @brief default destructor diff --git a/sources/System/Collision/CollisionSystem.hpp b/sources/System/Collision/CollisionSystem.hpp index 41b7d13c..f8748f61 100644 --- a/sources/System/Collision/CollisionSystem.hpp +++ b/sources/System/Collision/CollisionSystem.hpp @@ -15,6 +15,7 @@ namespace BBM class CollisionSystem : public WAL::System { private: + //! @brief reference to the ECS engine to get other entities WAL::Wal &_wal; public: //! @inherit @@ -22,11 +23,11 @@ namespace BBM //! @brief A default constructor CollisionSystem(WAL::Wal &wal); - //! @brief A movable system is copy constructable + //! @brief A Collision system is copy constructable CollisionSystem(const CollisionSystem &) = default; //! @brief A default destructor ~CollisionSystem() override = default; - //! @brief A movable system is assignable. + //! @brief A Collision system is assignable. CollisionSystem &operator=(const CollisionSystem &) = default; }; } \ No newline at end of file