From db7fd6a24c4da44fed3cee97d24f1cbda1471137 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 6 Nov 2024 12:07:43 +0100 Subject: `make format` --- mwe/events/include/event.h | 2 +- src/crepe/Component.cpp | 1 - src/crepe/Metadata.cpp | 4 ++-- src/crepe/Metadata.h | 3 ++- src/crepe/api/GameObject.cpp | 11 +++++++---- src/crepe/api/GameObject.h | 3 ++- src/crepe/api/Transform.cpp | 4 ++-- src/crepe/system/System.h | 4 ++-- 8 files changed, 18 insertions(+), 14 deletions(-) diff --git a/mwe/events/include/event.h b/mwe/events/include/event.h index 3e70201..16c75bf 100644 --- a/mwe/events/include/event.h +++ b/mwe/events/include/event.h @@ -152,7 +152,7 @@ private: }; class ShutDownEvent : public Event { public: - ShutDownEvent() : Event("ShutDownEvent"){}; + ShutDownEvent() : Event("ShutDownEvent") {}; REGISTER_EVENT_TYPE(ShutDownEvent) diff --git a/src/crepe/Component.cpp b/src/crepe/Component.cpp index 41e7273..358ce31 100644 --- a/src/crepe/Component.cpp +++ b/src/crepe/Component.cpp @@ -3,4 +3,3 @@ using namespace crepe; Component::Component(uint32_t id) : game_object_id(id), active(true) {} - diff --git a/src/crepe/Metadata.cpp b/src/crepe/Metadata.cpp index 1ba150a..53d93da 100644 --- a/src/crepe/Metadata.cpp +++ b/src/crepe/Metadata.cpp @@ -3,6 +3,6 @@ using namespace crepe; using namespace std; -Metadata::Metadata(uint32_t game_object_id, const string & name, const string & tag) +Metadata::Metadata(uint32_t game_object_id, const string & name, + const string & tag) : Component(game_object_id), name(name), tag(tag) {} - diff --git a/src/crepe/Metadata.h b/src/crepe/Metadata.h index b946fd0..1577987 100644 --- a/src/crepe/Metadata.h +++ b/src/crepe/Metadata.h @@ -9,7 +9,8 @@ namespace crepe { class Metadata : public Component { public: - Metadata(uint32_t game_object_id, const std::string & name, const std::string & tag); + Metadata(uint32_t game_object_id, const std::string & name, + const std::string & tag); virtual int get_instances_max() const { return 1; } public: diff --git a/src/crepe/api/GameObject.cpp b/src/crepe/api/GameObject.cpp index 8a1a235..51cd08f 100644 --- a/src/crepe/api/GameObject.cpp +++ b/src/crepe/api/GameObject.cpp @@ -6,7 +6,9 @@ using namespace crepe; using namespace std; -GameObject::GameObject(uint32_t id, std::string name, std::string tag, const Point & position, double rotation, double scale) : id(id) { +GameObject::GameObject(uint32_t id, std::string name, std::string tag, + const Point & position, double rotation, double scale) + : id(id) { ComponentManager & mgr = ComponentManager::get_instance(); mgr.add_component(this->id, position, rotation, scale); mgr.add_component(this->id, name, tag); @@ -16,11 +18,12 @@ void GameObject::set_parent(const GameObject & parent) { auto & mgr = ComponentManager::get_instance(); // set parent on own Metadata component - vector> this_metadata = mgr.get_components_by_id(this->id); + vector> this_metadata + = mgr.get_components_by_id(this->id); this_metadata.at(0).get().parent = parent.id; // add own id to children list of parent's Metadata component - vector> parent_metadata = mgr.get_components_by_id(parent.id); + vector> parent_metadata + = mgr.get_components_by_id(parent.id); parent_metadata.at(0).get().children.push_back(this->id); } - diff --git a/src/crepe/api/GameObject.h b/src/crepe/api/GameObject.h index 4c87639..602f33c 100644 --- a/src/crepe/api/GameObject.h +++ b/src/crepe/api/GameObject.h @@ -9,7 +9,8 @@ namespace crepe { class GameObject { public: - GameObject(uint32_t id, std::string name, std::string tag, const Point & position, double rotation, double scale); + GameObject(uint32_t id, std::string name, std::string tag, + const Point & position, double rotation, double scale); void set_parent(const GameObject & parent); template diff --git a/src/crepe/api/Transform.cpp b/src/crepe/api/Transform.cpp index 9c9bb06..1d8d401 100644 --- a/src/crepe/api/Transform.cpp +++ b/src/crepe/api/Transform.cpp @@ -8,10 +8,10 @@ using namespace crepe; -Transform::Transform(uint32_t game_id, const Point & point, double rot, double scale) +Transform::Transform(uint32_t game_id, const Point & point, double rot, + double scale) : Component(game_id), position(point), rotation(rot), scale(scale) { dbg_trace(); } Transform::~Transform() { dbg_trace(); } - diff --git a/src/crepe/system/System.h b/src/crepe/system/System.h index 8744920..ecbb7f5 100644 --- a/src/crepe/system/System.h +++ b/src/crepe/system/System.h @@ -8,8 +8,8 @@ public: virtual void update() = 0; protected: - System(){}; - virtual ~System(){}; + System() {}; + virtual ~System() {}; private: // singleton -- cgit v1.2.3 From 72095ca7d6e2b316202d963d07065993be0c5f45 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 6 Nov 2024 12:08:33 +0100 Subject: fix code style --- contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contributing.md b/contributing.md index e910dba..e88d0a9 100644 --- a/contributing.md +++ b/contributing.md @@ -277,7 +277,7 @@ that you can click on to open them. ```cpp struct Foo { - int bar; + int bar = 0; std::string baz; }; ``` @@ -285,7 +285,7 @@ that you can click on to open them. ```cpp struct Foo { - int bar = 0; + int bar; std::string baz; }; ``` -- cgit v1.2.3 From e4238e662b26cec586d601b778dec422683b498a Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 6 Nov 2024 13:22:17 +0100 Subject: update contributing.md --- contributing.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/contributing.md b/contributing.md index e88d0a9..8ed3b80 100644 --- a/contributing.md +++ b/contributing.md @@ -49,10 +49,10 @@ that you can click on to open them. class Cars {}; ``` -- Source files contain the following types of comments: +- Source files (.cpp, .hpp) contain the following types of comments: - What is the code supposed to do (optional) - Implementation details (if applicable) -- Header files contain the following types of comments: +- Header files (.h) contain the following types of comments: - Usage documentation (required) - Implementation details (if they affect the header) - Design/data structure decisions (if applicable) @@ -110,7 +110,8 @@ that you can click on to open them. ``` -
- using namespace may not be used in header files, only in source files. + using namespace may not be used in header files (.h, .hpp), only + in source files (.cpp).
GoodBad
example.h: -- cgit v1.2.3 From 4f953a35912c3d92c26bcb6c2cc77cc3ced176a3 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 6 Nov 2024 13:27:52 +0100 Subject: update contributing.md --- contributing.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/contributing.md b/contributing.md index 8ed3b80..88cba32 100644 --- a/contributing.md +++ b/contributing.md @@ -54,6 +54,9 @@ that you can click on to open them. - Implementation details (if applicable) - Header files (.h) contain the following types of comments: - Usage documentation (required) + + > [!NOTE] + > Constructors/destructors aren't required to have a `\brief` description - Implementation details (if they affect the header) - Design/data structure decisions (if applicable) -
-- cgit v1.2.3