diff options
Diffstat (limited to 'docs/styleguide-cpp.md')
| -rw-r--r-- | docs/styleguide-cpp.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/styleguide-cpp.md b/docs/styleguide-cpp.md index 6440314..83a2647 100644 --- a/docs/styleguide-cpp.md +++ b/docs/styleguide-cpp.md @@ -1,4 +1,4 @@ -# OpenVic2 C++ Style Guidelines +# OpenVic C++ Style Guidelines ## Table of Contents 1. [Why Style?](styleguide-cpp.md#1-why-style) @@ -34,9 +34,9 @@ Source code files should adhere to the following: - Any `#include` directives should be at the top of the file - Any header files have the `.hpp` file extension - Any implementation files have the `.cpp` file extension -- Code should be within the `OpenVic2` namespace (or a nested namespace) -- Any submodules or third-party utilities should be in the `OpenVic2/extension/deps` directory -- Groups of related source files should be kept in a sub-directory of `OpenVic2/extension/src` +- Code should be within the `OpenVic` namespace (or a nested namespace) +- Any submodules or third-party utilities should be in the `OpenVic/extension/deps` directory +- Groups of related source files should be kept in a sub-directory of `OpenVic/extension/src` - Any lines that are longer than 120 characters in length should be split across multiple lines ## 2. Conventions @@ -298,22 +298,22 @@ Source code files should adhere to the following: return true; } ``` -- The include order should be: C++ standard headers, followed by Godot headers, then OpenVic2 headers +- The include order should be: C++ standard headers, followed by Godot headers, then OpenVic headers - C++ standard headers and Godot headers should be enclosed by angle brackets `<>` - - OpenVic2 headers should be enclosed by double quotes `""` + - OpenVic headers should be enclosed by double quotes `""` ```c++ //Correct #include <vector> #include <string> #include <godot_cpp/classes/object.hpp> #include <godot_cpp/core/class_db.hpp> - #include "openvic2/src/SampleHeader.hpp" - #include "openvic2/src/SampleHeader2.hpp" + #include "openvic/src/SampleHeader.hpp" + #include "openvic/src/SampleHeader2.hpp" //Incorrect - #include "openvic2/src/SampleHeader.hpp" + #include "openvic/src/SampleHeader.hpp" #include <godot_cpp/classes/object.hpp> - #include "openvic2/src/SampleHeader2.hpp" + #include "openvic/src/SampleHeader2.hpp" #include <godot_cpp/core/class_db.hpp> #include <vector> #include <string> |