Merge pull request #393 from CBATeam/function-header-PFH

Improve function header 'CBA_fnc_addPerFrameHandler'
CBATeam · Jun 23, 2016 · 0e505cc · 0e505cc
2 parents a16d8aa + 4071e32
commit 0e505cc
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/addons/common/fnc_addPerFrameHandler.sqf b/addons/common/fnc_addPerFrameHandler.sqf
@@ -6,11 +6,16 @@ Description:
 
 Parameters:
     _function - The function you wish to execute. <CODE>
-    _delay    - The amount of time in seconds between executions, 0 for every frame. [optional] (default: 0) <NUMBER>
-    _args     - Parameters passed to the function executing. This will be the same array every execution. [optional] <ANY>
+    _delay    - The amount of time in seconds between executions, 0 for every frame. (optional, default: 0) <NUMBER>
+    _args     - Parameters passed to the function executing. This will be the same array every execution. (optional) <ANY>
+
+Passed Arguments:
+    _this <ARRAY>
+        0: _args   - Parameters passed by this function. Same as '_args' above. <ANY>
+        1: _handle - A number representing the handle of the function. Same as '_handle' returned by this function. <NUMBER>
 
 Returns:
-    _handle - a number representing the handle of the function. Use this to remove the handler. <NUMBER>
+    _handle - A number representing the handle of the function. Use this to remove the handler. <NUMBER>
 
 Examples:
     (begin example)