diff options
| -rw-r--r-- | contributing.md | 14 | ||||
| -rw-r--r-- | mwe/events/include/event.h | 2 | ||||
| -rw-r--r-- | src/crepe/system/System.h | 4 |
3 files changed, 12 insertions, 8 deletions
diff --git a/contributing.md b/contributing.md index e910dba..88cba32 100644 --- a/contributing.md +++ b/contributing.md @@ -49,11 +49,14 @@ that you can click on to open them. class Cars {}; ``` </td></tr></table></details> -- 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) + + > [!NOTE] + > Constructors/destructors aren't required to have a `\brief` description - Implementation details (if they affect the header) - Design/data structure decisions (if applicable) - <details><summary> @@ -110,7 +113,8 @@ that you can click on to open them. ``` </td></tr></table></details> - <details><summary> - <code>using namespace</code> may not be used in header files, only in source files. + <code>using namespace</code> may not be used in header files (.h, .hpp), only + in source files (.cpp). </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td> example.h: @@ -277,7 +281,7 @@ that you can click on to open them. ```cpp struct Foo { - int bar; + int bar = 0; std::string baz; }; ``` @@ -285,7 +289,7 @@ that you can click on to open them. ```cpp struct Foo { - int bar = 0; + int bar; std::string baz; }; ``` 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/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 |