Arma3_Epoch/ACE3
1
0
Fork 0
mirror of https://github.com/acemod/ACE3.git synced 2024-08-30 18:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #711 from usecforce/wiki-wording

Browse Source 
Wiki wording
This commit is contained in:
jaynus 2015-04-18 14:24:31 -07:00
commit a428abea84
3 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/development/coding-guidelines.md
View File

@ -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

2
documentation/development/extension-guidelines.md
View File

@ -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

14
documentation/development/modularity-and-pbo-structure.md
View File

@ -10,23 +10,21 @@ 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
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.
- Interaction would be the requirement for most modules.
- Anything that is 100% config should require Common and not Interaction.
```
Main -> Common -> OptionsMenu -> InteractionMenu -> Most things
Main -> Common -> OptionsMenu -> Interaction -> Most things
Main -> Common -> Config things
Main -> Common -> 3D Models |
InteractionMenu | -> Feature
Main -> Common -> 3D Models |
Interaction | -> Feature
```