Merge branch 'codingGuidelinesMacroListFix' of https://github.com/usecforce/ACE3 into doc-merge

This commit is contained in:
KoffeinFlummi 2015-05-10 16:41:48 +02:00
commit f103a19920

View File

@ -121,7 +121,7 @@ Every function should have a header of the following format:
## 4. Macro Usage
### 4.1 Module/PBO specific Macro Usage
The family of `GVAR` macro's define global variable strings or constants for use within a module. Please use these to make sure we follow naming conventions across all modules and also prevent duplicate/overwriting between variables in different modules. The macro family expands as follows, for the example of the module 'balls'
The family of `GVAR` macro's define global variable strings or constants for use within a module. Please use these to make sure we follow naming conventions across all modules and also prevent duplicate/overwriting between variables in different modules. The macro family expands as follows, for the example of the module 'balls':
* `GVAR(face)` is `ace_balls_face`
* `QGVAR(face)` is `"ace_balls_face"`
@ -130,7 +130,7 @@ The family of `GVAR` macro's define global variable strings or constants for use
* `QEGVAR(leg,face)` is `"ace_leg_face"`
There also exists the FUNC family of Macros
There also exists the FUNC family of Macros:
* `FUNC(face)` is `ace_balls_fnc_face` or the call trace wrapper for that function.
* `EFUNC(balls,face)` is `ace_balls_fnc_face` or the call trace wrapper for that function.