From 38f32cad0dc505798cbccd1da2ff423aa75e3913 Mon Sep 17 00:00:00 2001 From: jonpas Date: Fri, 17 Apr 2015 17:40:13 +0200 Subject: [PATCH 1/4] bracket -> brace --- documentation/development/coding-guidelines.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/development/coding-guidelines.md b/documentation/development/coding-guidelines.md index f72263eeaa..e39581a9d4 100644 --- a/documentation/development/coding-guidelines.md +++ b/documentation/development/coding-guidelines.md @@ -35,8 +35,8 @@ Tabs can be tricky sometimes, especially when it comes to sharing code with othe ## Braces -- opening bracket on the same line as keyword -- closing bracket in own line, same level of indentation as keyword +- opening brace on the same line as keyword +- closing brace in own line, same level of indentation as keyword **Yes:** @@ -70,7 +70,7 @@ class Something : Or { }; ``` -When using `if`/`else`, it is encouraged to put `else` on the same line as the closing bracket to save space: +When using `if`/`else`, it is encouraged to put `else` on the same line as the closing brace to save space: ```c++ if (alive player) then { @@ -90,7 +90,7 @@ class Three {foo = 3;}; #### Reasoning -Putting the opening bracket in it's own line wastes a lot of space, and keeping the closing bracket on the same level as the keyword makes it easier to recognize what exactly the bracket closes. +Putting the opening brace in it's own line wastes a lot of space, and keeping the closing brace on the same level as the keyword makes it easier to recognize what exactly the brace closes. ## How to create a new module From ba576c5763cf0310576eba7e45cbb9d898d236c0 Mon Sep 17 00:00:00 2001 From: jonpas Date: Fri, 17 Apr 2015 17:42:03 +0200 Subject: [PATCH 2/4] Capitalized Visual Studio, Corrected togglable spelling --- documentation/development/extension-guidelines.md | 2 +- documentation/development/modularity-and-pbo-structure.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/development/extension-guidelines.md b/documentation/development/extension-guidelines.md index 0558d49d5e..b5e7e98586 100644 --- a/documentation/development/extension-guidelines.md +++ b/documentation/development/extension-guidelines.md @@ -11,7 +11,7 @@ order: 9 ### Requirements - A compiler (VS/GCC/Clang) - - If starting with visual studio, you need to make sure to use the Visual studio command prompt + - If starting with Visual Studio, you need to make sure to use the Visual studio command prompt - cmake 3.0 or later in your path ### Cross-Platform Guidelines diff --git a/documentation/development/modularity-and-pbo-structure.md b/documentation/development/modularity-and-pbo-structure.md index ad1194e39c..e3e8c5002a 100644 --- a/documentation/development/modularity-and-pbo-structure.md +++ b/documentation/development/modularity-and-pbo-structure.md @@ -10,7 +10,7 @@ order: 4 Main principles: - As much stuff as possible should be modular -- Strive to make as much stuff as possible run-time toogable. Adding/removing PBOS would still be requiring to toogle any feature relying on config changes. +- Strive to make as much stuff as possible run-time togglable. Adding/removing PBOS would still be requiring to toggle any feature relying on config changes. ### PBO Structure From 2d5b10fb601d0cafa8b975798ce3ff96e5902a1d Mon Sep 17 00:00:00 2001 From: jonpas Date: Fri, 17 Apr 2015 17:45:10 +0200 Subject: [PATCH 3/4] Module names --- .../development/modularity-and-pbo-structure.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/development/modularity-and-pbo-structure.md b/documentation/development/modularity-and-pbo-structure.md index e3e8c5002a..0c16c4bc97 100644 --- a/documentation/development/modularity-and-pbo-structure.md +++ b/documentation/development/modularity-and-pbo-structure.md @@ -17,16 +17,16 @@ Main principles: Main principles: - Try to keep single module dependencies as much as possible -- InteractionMenu would be the requirement for most modules. -- Anything that is 100% config should require common and not interaction. +- Interact_Menu would be the requirement for most modules. +- Anything that is 100% config should require Common and not Interact_Menu. ``` -Main -> Common -> OptionsMenu -> InteractionMenu -> Most things +Main -> Common -> OptionsMenu -> Interact_Menu -> Most things Main -> Common -> Config things -Main -> Common -> 3D Models | - InteractionMenu | -> Feature +Main -> Common -> 3D Models | + Interact_Menu | -> Feature ``` From 9cede7cf85ab3882f54c879570edbcfd2172328a Mon Sep 17 00:00:00 2001 From: jonpas Date: Fri, 17 Apr 2015 19:10:41 +0200 Subject: [PATCH 4/4] Module name Interact_Menu -> Interaction in documentation --- .../development/modularity-and-pbo-structure.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/documentation/development/modularity-and-pbo-structure.md b/documentation/development/modularity-and-pbo-structure.md index 0c16c4bc97..036ebb35d4 100644 --- a/documentation/development/modularity-and-pbo-structure.md +++ b/documentation/development/modularity-and-pbo-structure.md @@ -17,16 +17,14 @@ Main principles: Main principles: - Try to keep single module dependencies as much as possible -- Interact_Menu would be the requirement for most modules. -- Anything that is 100% config should require Common and not Interact_Menu. +- Interaction would be the requirement for most modules. +- Anything that is 100% config should require Common and not Interaction. ``` -Main -> Common -> OptionsMenu -> Interact_Menu -> Most things +Main -> Common -> OptionsMenu -> Interaction -> Most things Main -> Common -> Config things Main -> Common -> 3D Models | - Interact_Menu | -> Feature + Interaction | -> Feature ``` - -