General - Various header fixes

addons/advanced_throwing/functions/fnc_drawArc.sqf

@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * Flight path (just for debug) <ARRAY>
+ * Flight path (just for debug) <ARRAY or NIL>
  *
  * Example:
  * call ace_advanced_throwing_fnc_drawArc

addons/artillerytables/functions/fnc_interactMenuOpened.sqf

@@ -7,7 +7,7 @@
  * 0: Menu Type (1 is self interaction) <NUMBER>
  *
  * Return Value:
- * Can Open <BOOL>
+ * None
  *
  * Example:
  * [1] call ace_artillerytables_fnc_interactMenuOpened

addons/attach/functions/fnc_canAttach.sqf

@@ -6,7 +6,7 @@
  * Arguments:
  * 0: vehicle that it will be attached to (player or vehicle) <OBJECT>
  * 1: unit doing the attach (player) <OBJECT>
- * 2: Array empty or containing a string of the attachable item <ARRAY>
+ * 2: Array empty or containing a string of the attachable item <STRING or ARRAY of STRING>
  *
  * Return Value:
  * Can Attach <BOOL>

addons/attach/functions/fnc_placeApprove.sqf

@@ -15,7 +15,7 @@
  * 3: Light Vehicle Classname <STRING>
  * 4: On Attach Text <STRING>
  * 5: Starting Pos of dummy item <ARRAY>
- * 5: Orientation of model <ARRAY>
+ * 6: Orientation of model <ARRAY>
  *
  * Return Value:
  * None

addons/backpacks/functions/fnc_backpackOpened.sqf

@@ -5,14 +5,13 @@
  *
  * Arguments:
  * 0: Who accessed your inventory? <OBJECT>
- * 1: Unit that wields the backpack <OBJECT>
- * 2: The backpack object <OBJECT>
+ * 1: The backpack object <OBJECT>
  *
  * Return Value:
  * None
  *
  * Example:
- * [bob, kevin, backpack] call ace_backpacks_fnc_backpackOpened
+ * [bob, backpack] call ace_backpacks_fnc_backpackOpened
  *
  * Public: No
  */

addons/captives/functions/fnc_doApplyHandcuffs.sqf

@@ -8,7 +8,7 @@
  * 1: target <OBJECT>
  *
  * Return Value:
- * The return value <BOOL>
+ * None
  *
  * Example:
  * [player, bob] call ACE_captives_fnc_doApplyHandcuffs;

addons/captives/functions/fnc_doRemoveHandcuffs.sqf

@@ -8,7 +8,7 @@
  * 1: Target <OBJECT>
  *
  * Return Value:
- * The return value <BOOL>
+ * None
  *
  * Example:
  * [bob, bill] call ACE_captives_fnc_doRemoveHandcuffs

addons/captives/functions/fnc_handleGetIn.sqf

@@ -9,7 +9,7 @@
  * 2: _unit <OBJECT>
  *
  * Return Value:
- * The return value <BOOL>
+ * None
  *
  * Example:
  * [car2, x, player] call ACE_captives_fnc_handleGetIn

addons/captives/functions/fnc_handleGetOut.sqf

@@ -9,7 +9,7 @@
  * 2: _unit <OBJECT>
  *
  * Return Value:
- * The return value <BOOL>
+ * None
  *
  * Example:
  * [car2, x, player] call ACE_captives_fnc_handleGetOut

addons/captives/functions/fnc_handleOnUnconscious.sqf

@@ -5,7 +5,7 @@
  *
  * Arguments:
  * 0: Unit <OBJECT>
- * 0: Is Unconsisisiouses <BOOL>
+ * 1: Is Unconscious <BOOL>
  *
  * Return Value:
  * None

addons/captives/functions/fnc_handlePlayerChanged.sqf

@@ -8,7 +8,7 @@
  * 1: _oldUnit <OBJECT>
  *
  * Return Value:
- * The return value <BOOL>
+ * None
  *
  * Example:
  * [bob1, bob2] call ACE_captives_fnc_handlePlayerChanged

addons/captives/functions/fnc_handleUnitInitPost.sqf

@@ -7,7 +7,7 @@
  * 0: _unit <OBJECT>
  *
  * Return Value:
- * The return value <BOOL>
+ * None
  *
  * Example:
  * [bob] call ACE_captives_fnc_handleUnitInitPost

addons/captives/functions/fnc_setHandcuffed.sqf

@@ -6,7 +6,7 @@
  * Arguments:
  * 0: Unit <OBJECT>
  * 1: True to take captive, false to release captive <BOOL>
- * 2: Caller <OBJECT>
+ * 2: Caller <OBJECT> (default: objNull)
  *
  * Return Value:
  * None

addons/cargo/functions/fnc_getSelectedItem.sqf

@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * Classname of selected item or selected object <STRING or OBJECT> (default: nil)
+ * Classname of selected item or selected object <STRING or OBJECT or NIL> (default: nil)
  *
  * Example:
  * call ace_cargo_fnc_getSelectedItem

addons/common/functions/fnc_ASLToPosition.sqf

@@ -9,7 +9,7 @@
  * 2: position z <NUMBER>
  *
  * Return Value:
- * None
+ * <ARRAY>
  *
  * Example:
  * [1, 2, 3] call ace_common_fnc_ASLToPosition

addons/common/functions/fnc_assignObjectsInList.sqf

@@ -5,7 +5,7 @@
  * Used by moduleAssign* within various parts of the ACE3 project.
  *
  * Arguments:
- * 0: List <STRING>
+ * 0: List <STRING or ARRAY>
  * 1: Variable Name <STRING>
  * 2: Value <ANY>
  * 3: Global <BOOL>

addons/common/functions/fnc_blurScreen.sqf

@@ -4,7 +4,7 @@
  * Blurs screen.
  *
  * Arguments:
- * 0: ID <NUMBER>
+ * 0: ID <NUMBER or STRING>
  * 1: Show? <BOOL or NUMBER>
  *
  * Return Value:

addons/common/functions/fnc_cachedCall.sqf

@@ -4,9 +4,9 @@
  * Returns the result of the function and caches it up to a given time or event
  *
  * Arguments:
- * 0: Parameters <ARRAY>
+ * 0: Parameters <ANY>
  * 1: Function <CODE>
- * 2: Namespace to store the cache on <NAMESPACE>
+ * 2: Namespace (any type that supports setVariable) to store the cache on <ANY>
  * 3: Cache uid <STRING>
  * 4: Max duration of the cache <NUMBER>
  * 5: Events that clear the cache <STRING or ARRAY of STRINGs> (default: nil)

addons/common/functions/fnc_canDig.sqf

@@ -4,7 +4,7 @@
  * Checks if the player can dig on the surface below (enough dust).
  *
  * Arguments:
- * 0: Unit or Position (2d/3d) <OBJECT><ARRAY>
+ * 0: Unit or Position (2d/3d) <OBJECT or ARRAY>
  *
  * Return Value:
  * Can Dig <BOOL>

addons/common/functions/fnc_eraseCache.sqf

@@ -4,7 +4,7 @@
  * Deletes a cached result
  *
  * Arguments:
- * 0: Namespace to store the cache on <NAMESPACE>
+ * 0: Namespace (any type that supports setVariable) to store the cache on <ANY>
  * 1: Cache uid <STRING>
  *
  * Return Value:

addons/common/functions/fnc_errorMessage.sqf

@@ -7,7 +7,7 @@
  *
  * Arguments:
  * 0: Header <STRING>
- * 1: Text <STRING or TEXT>
+ * 1: Text <STRING or STRUCTUREDTEXT>
  *
  * Return Value:
  * None

addons/common/functions/fnc_getItemReplacements.sqf

@@ -8,7 +8,7 @@
  * 1: Include type replacements for items <BOOL> (default: true)
  *
  * Return Value:
- * Item replacements <ARRAY of STRINGs> if replacements exist, nil if not
+ * Item replacements (strings if replacements exist, nil if not) <ARRAY of STRINGs or NIL>
  *
  * Example:
  * ["FirstAidKit", false] call ace_common_fnc_getItemReplacements

addons/common/functions/fnc_getVehicleCodriver.sqf

@@ -4,7 +4,7 @@
  * Get the vehicle codriver positions.
  *
  * Arguments:
- * 0: Vehicle type <STRING>
+ * 0: Vehicle <OBJECT>
  *
  * Return Value:
  * Vehicle codriver positions <ARRAY>

addons/common/functions/fnc_isPlayer.sqf

@@ -6,7 +6,7 @@
  *
  * Arguments:
  * 0: unit to be checked <OBJECT>
- * 1: exclude remote controlled units <BOOL>
+ * 1: exclude remote controlled units <BOOL> (default: false)
  *
  * Return Value:
  * Is unit a player? <BOOL>

addons/common/functions/fnc_loadPerson.sqf

@@ -7,8 +7,8 @@
  * 0: Unit that will load <OBJECT>
  * 1: Unit to be loaded <OBJECT>
  * 2: Vehicle that the unit will be loaded in <OBJECT> (default: objNull)
- * 3: Preferred seats <ARRAY>
- * 4: Reverse fill <BOOL>
+ * 3: Preferred seats <ARRAY> (default: [])
+ * 4: Reverse fill <BOOL> (default: false)
  *
  * Return Value:
  * Vehicle that the unitToBeloaded has been loaded in. Returns objNull if function failed <OBJECT>

addons/common/functions/fnc_normalRandom.sqf

@@ -5,8 +5,8 @@
  * Uses Box-Muller transform to approximate distribution
  *
  * Arguments:
- * 0: Mean <NUMBER> or <ARRAY>
- * 1: Standard Deviation <NUMBER> or <ARRAY>
+ * 0: Mean <NUMBER or ARRAY>
+ * 1: Standard Deviation <NUMBER or ARRAY>
  *
  * Return Value:
  * Pair of random numbers according to normal distribution <ARRAY>

addons/common/functions/fnc_positionToASL.sqf

@@ -9,7 +9,7 @@
  * 2: Position z <NUMBER>
  *
  * Return Value:
- * None
+ * PosASL <ARRAY>
  *
  * Example:
  * [1, 1, 1] call ace_common_fnc_positionToASL

addons/common/functions/fnc_rscObjectHelper.sqf

@@ -5,7 +5,7 @@
  *
  * Arguments:
  * 0: Function <STRING>
- * 1: Input array <CODE>
+ * 1: Input array <ARRAY>
  * 2: Scale <NUMBER> (default: 1)
  *
  * Return Value:

addons/common/functions/fnc_sendRequest.sqf

@@ -8,13 +8,13 @@
  * 1: target <OBJECT>
  * 2: requestID <STRING>
  * 3: requestMessage Will be localized for other target object. <STRING>
- * 4: callback Code called upon accept or decline. <CODE>
+ * 4: callback Code called upon accept or decline. <STRING>
  *
  * Return Value:
  * None
  *
  * Example:
- * [bob, kevin, "ID", "Message", {callback}] call ace_common_fnc_sendRequest
+ * [bob, kevin, "ID", "Message", "call code"] call ace_common_fnc_sendRequest
  *
  * Public: Yes
  */

addons/common/functions/fnc_setDead.sqf

@@ -4,10 +4,10 @@
  * Kills a unit without changing visual appearance.
  *
  * Arguments:
- * 0: Unit <ARRAY>
+ * 0: Unit <OBJECT>
  * 1: Reason for death (only used if ace_medical is loaded) <STRING> (default: "")
- * 2: Killer (vehicle that killed unit) <ARRAY> (default: objNull)
- * 3: Instigator (unit who pulled trigger) <ARRAY> (default: objNull)
+ * 2: Killer (vehicle that killed unit) <OBJECT> (default: objNull)
+ * 3: Instigator (unit who pulled trigger) <OBJECT> (default: objNull)
  *
  * Return Value:
  * None

addons/common/functions/fnc_statusEffect_addType.sqf

@@ -7,7 +7,7 @@
  * 0: Status Effect Name, this should match a corresponding event name <STRING>
  * 1: Send event globally <BOOL>
  * 2: Common Effect Reasons to pre-seed during init <ARRAY>
- * 3: Send event to JIP (requires sending event globally) <BOOL>
+ * 3: Send event to JIP (requires sending event globally) <BOOL> (default: false)
  * 4: Event name <STRING> (default: "ace_common_<effect>")
  *
  * Return Value:

addons/common/functions/fnc_stringToColoredText.sqf

@@ -8,7 +8,7 @@
  * 1: Color <ARRAY or STRING>
  *
  * Return Value:
- * Text <STRING>
+ * Text <STRUCTUREDTEXT>
  *
  * Example:
  * ["text", [0, 1, 2]] call ace_common_fnc_stringToColoredText

addons/common/functions/fnc_toBitmask.sqf

@@ -2,12 +2,10 @@
 /*
  * Author: commy2
  * Convert an array of booleans into a number.
+ * Takes Input <ARRAY of BOOLs> (limited to float precision)
  *
  * Arguments:
- * 0: Boolean <BOOL>
- * 1: Boolean <BOOL>
- * 2: Boolean <BOOL>
- * ...
+ * 0: Boolean (least significant bit) <BOOL>
  *
  * Return Value:
  * Bitmask <NUMBER>

addons/common/functions/fnc_uniqueItems.sqf

@@ -5,8 +5,8 @@
  *
  * Arguments:
  * 0: Target <OBJECT>
- * 1: Include magazines <NUMBER>
- *   0: No (default)
+ * 1: Include magazines <NUMBER> (default: 0)
+ *   0: No
  *   1: Yes
  *   2: Only magazines
  *

addons/common/functions/fnc_updatePlayerVehAttenuation.sqf

@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * Amount that unit can hear outside <NUMBER>
+ * None
  *
  * Example:
  * call ace_common_fnc_updatePlayerVehAttenuation

addons/cookoff/functions/fnc_cookOffLocal.sqf

@@ -7,7 +7,7 @@
  * 0: Vehicle <OBJECT>
  * 1: Spawn fire jet <BOOL>
  * 2: Spawn fire ring <BOOL>
- * 3: What selection fire will originate from <STRING><ARRAY>
+ * 3: What selection fire will originate from <STRING or ARRAY>
  * 4: Cookoff intensity value <NUMBER>
  * 5: Start time <NUMBER>
  * 6: Duration of effect (max 20 seconds) <NUMBER>

addons/cookoff/functions/fnc_cookOffServer.sqf

@@ -12,7 +12,7 @@
  * 4: Delay between smoke and fire enabled <BOOL> (default: true)
  * 5: Ammo detonation chance <NUMBER> (default: 0)
  * 6: Detonate after cook-off <BOOL> (default: false)
- * 7: Selection for fire source <STRING><ARRAY> (default: "")
+ * 7: Selection for fire source <STRING or ARRAY> (default: "")
  * 8: Can spawn fire ring <BOOL> (default: true)
  * 9: Can spawn fire jet <BOOL> (default: true)
  * 10: Maximum intensity <NUMBER> (default: MAX_COOKOFF_INTENSITY)

addons/cookoff/functions/fnc_handleDamageBox.sqf

@@ -7,7 +7,7 @@
  * HandleDamage EH <ARRAY>
  *
  * Return Value:
- * Damage to be inflicted (can be nil) <NUMBER>
+ * Damage to be inflicted (can be nil) <NUMBER or NIL>
  *
  * Example:
  * _this call ace_cookoff_fnc_handleDamageBox

addons/csw/functions/fnc_proxyWeapon.sqf

@@ -7,7 +7,7 @@
  * 0: CSW <OBJECT>
  * 1: Turret <ARRAY>
  * 2: Proxy weapon needed <BOOL>
- * 2: Weapon should be emptied <BOOL>
+ * 3: Weapon should be emptied <BOOL>
  *
  * Return Value:
  * None

addons/dagr/functions/fnc_programWP.sqf

@@ -4,9 +4,10 @@
  * API to program Waypoints into the DAGR
  *
  * Arguments:
- * 0: Position (2D,3D) <NUMBER>
- * 1: Waypoint Name <STRING>
- * 2: Index (Optional) <NUMBER>
+ * 0: Position (2D,3D) <ARRAY>
+ * 1: Waypoint Name <STRING> (default: "Waypoint")
+ * 2: Index <NUMBER> (default: auto-assign)
+ *
  * Return Value:
  * None
  *