Merge pull request #1794 from CBATeam/headerCleanup

PabstMirror · web-flow · commit 1fb24ad391ff · 2025-12-08T10:20:02.000-06:00
General - Cleanup headers and fix some return values
diff --git a/addons/accessory/fnc_switchAttachment.sqf b/addons/accessory/fnc_switchAttachment.sqf
@@ -23,7 +23,7 @@ Author:
 ---------------------------------------------------------------------------- */
 
 params ["_itemType", "_switchTo"];
-if (!isNull curatorCamera) exitWith {};
+if (!isNull curatorCamera) exitWith {false};
 
 private ["_currItem", "_switchItem"];
 private _unit = call CBA_fnc_currentUnit;
diff --git a/addons/common/fnc_addMagazine.sqf b/addons/common/fnc_addMagazine.sqf
@@ -11,9 +11,9 @@ Description:
 Parameters:
     _unit   - the unit or vehicle <OBJECT>
     _item   - name of the magazine to add <STRING>
-    _ammo   - ammo count <NUMBER>
-    _verify - if true, then put item in vehicle or on the ground if it can't be added <BOOLEAN>
-    _skipAnim - does not play the animation when true (optional, default: false) <BOOLEAN>
+    _ammo   - ammo count <NUMBER> (Default: -1, which means full magazine)
+    _verify - if true, then put item in vehicle or on the ground if it can't be added <BOOLEAN> (Default: false)
+    _skipAnim - does not play the animation when true (optional, default: false) <BOOLEAN> (Default: false)
 
 Returns:
     true on success, false otherwise <BOOLEAN>
diff --git a/addons/common/fnc_addMagazineCargo.sqf b/addons/common/fnc_addMagazineCargo.sqf
@@ -12,7 +12,7 @@ Parameters:
     _container - the vehicle <OBJECT>
     _item      - name of magazine to <STRING>
     _count     - number of magazines to add <NUMBER> (Default: 1)
-    _verify    - if true, then put item on the ground if it can't be added <BOOLEAN>
+    _verify    - if true, then put item on the ground if it can't be added <BOOLEAN> (Default: false)
     _ammo      - ammo count <NUMBER> (Default: 1E6)
 
 Returns:
diff --git a/addons/common/fnc_addWeapon.sqf b/addons/common/fnc_addWeapon.sqf
@@ -11,8 +11,8 @@ Description:
 Parameters:
     _unit   - the unit <OBJECT>
     _item   - name of the weapon to add <STRING>
-    _verify - if true, then put item on the ground if it can't be added <BOOLEAN>
-    _skipAnim - does not play the animation when true (optional, default: false) <BOOLEAN>
+    _verify - if true, then put item on the ground if it can't be added <BOOLEAN> (Default: false)
+    _skipAnim - does not play the animation when true (optional, default: false) <BOOLEAN> (Default: false)
 
 Returns:
     true on success, false otherwise <BOOLEAN>
diff --git a/addons/common/fnc_addWeaponCargo.sqf b/addons/common/fnc_addWeaponCargo.sqf
@@ -12,7 +12,7 @@ Parameters:
     _container - the vehicle <OBJECT>
     _item      - name of weapon <STRING>
     _count     - number of weapons to add <NUMBER> (Default: 1)
-    _verify    - if true, then put item on the ground if it can't be added <BOOLEAN>
+    _verify    - if true, then put item on the ground if it can't be added <BOOLEAN> (Default: false)
 
 Returns:
     true on success, false otherwise <BOOLEAN>
diff --git a/addons/common/fnc_addWeaponWithoutItems.sqf b/addons/common/fnc_addWeaponWithoutItems.sqf
@@ -9,7 +9,7 @@ Description:
     Attempts to keep magazine ids for unrelated magazines.
 
 Parameters:
-    _unit               - Unit to add the weapon to <OBEJCT>
+    _unit               - Unit to add the weapon to <OBJECT>
     _weapon             - Weapon to add <STRING>
     _removeLinkedItems  - If linked items should be removed or not <BOOLEAN> (Default: true)
 
diff --git a/addons/common/fnc_deleteNamespace.sqf b/addons/common/fnc_deleteNamespace.sqf
@@ -6,7 +6,7 @@ Description:
     Deletes a namespace created with CBA_fnc_createNamespace.
 
 Parameters:
-    _namespace - a namespace <LOCATION>
+    _namespace - a namespace <LOCATION or OBJECT>
 
 Returns:
     None
diff --git a/addons/common/fnc_findEntity.sqf b/addons/common/fnc_findEntity.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     - Type (Classname or Object) <STRING, OBJECT>
-    - Position <OBJECT, LOCATION, GROUP, TASK, MARKER, POSITION>
+    - Position <OBJECT, LOCATION, GROUP, TASK, MARKER, ARRAY>
 
 Optional:
     - Radius <NUMBER>
diff --git a/addons/common/fnc_getAlive.sqf b/addons/common/fnc_getAlive.sqf
@@ -6,15 +6,15 @@ Description:
     A function used to find out who is alive in an array or a group.
 
 Parameters:
-    _entities - Array or Group <GROUP, ARRAY>
+    _entities - Array or Group <GROUP, ARRAY, OBJECT>
 
 Example:
     (begin example)
         _alive = (units player) call CBA_fnc_getAlive
     (end)
 
 Returns:
-    <ARRAY>
+    <ARRAY> (or <BOOL> if a single object is passed)
 
 Author:
     Rommel
diff --git a/addons/common/fnc_getCfgDataHashmap.sqf b/addons/common/fnc_getCfgDataHashmap.sqf
@@ -17,7 +17,7 @@ Parameters:
     _convert    - convert certain values - see above (optional, default: true) <BOOL>
 
 Returns:
-    properties <HASHMAP>
+    properties <HASHMAP> (or <NIL> if _cfg is invalid)
 
 Examples:
     (begin example)
diff --git a/addons/common/fnc_getCfgDataRandom.sqf b/addons/common/fnc_getCfgDataRandom.sqf
@@ -12,7 +12,7 @@ Parameters:
     _cfg  - Entry to get value of <CONFIG>
 
 Returns:
-    Value found <STRING or NUMBER>
+    Value found <STRING or NUMBER or NIL>
 
 Examples:
     (begin example)
diff --git a/addons/common/fnc_getDistance.sqf b/addons/common/fnc_getDistance.sqf
@@ -6,7 +6,7 @@ Description:
     A function used to find out the distance between two positions.
 
 Parameters:
-    Array containing two of <MARKER, OBJECT, LOCATION, GROUP, TASK, POSITION>
+    Array containing two of <MARKER, OBJECT, LOCATION, GROUP, TASK, ARRAY>
 
 Example:
     (begin example)
diff --git a/addons/common/fnc_getMagazineIndex.sqf b/addons/common/fnc_getMagazineIndex.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _unit     - Unit to check <OBJECT>
-    _magazine - Magazines to check <OBJECT>
+    _magazine - Magazines to check <STRING>
 
 Returns:
     Magazine IDs <ARRAY of STRINGS>
diff --git a/addons/common/fnc_getNearestBuilding.sqf b/addons/common/fnc_getNearestBuilding.sqf
@@ -6,7 +6,7 @@ Description:
     Find the nearest building and number of building positions available.
 
 Parameters:
-    _position - <OBJECT, POSITION>
+    _position - <OBJECT, ARRAY>
 
 Example:
     (begin example)
diff --git a/addons/common/fnc_getTurret.sqf b/addons/common/fnc_getTurret.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _vehicle    - Vehicle or vehicle class name or vehicle config <STRING, OBJECT, CONFIG>
-    _turretPath - Turret path <ARRAY>
+    _turretPath - Turret path <ARRAY> (Default: [])
 
 Example:
     (begin example)
diff --git a/addons/common/fnc_randPos.sqf b/addons/common/fnc_randPos.sqf
@@ -6,7 +6,7 @@ Description:
     A function used to randomize a position around a given center
 
 Parameters:
-    _position  - <MARKER, OBJECT, LOCATION, GROUP, TASK or POSITION>
+    _position  - <MARKER, OBJECT, LOCATION, GROUP, TASK or ARRAY>
     _radius    - random Radius <NUMBER>
     _direction - randomization direction (optional, default: 0) <NUMBER>
     _angle     - the angle of the circular arc in which the random position will end up. (optional, default: 360) <NUMBER>
diff --git a/addons/common/fnc_setPos.sqf b/addons/common/fnc_setPos.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _entity   - <MARKER, OBJECT, LOCATION, GROUP, TASK>
-    _position - <MARKER, OBJECT, LOCATION, GROUP, TASK, POSITION>
+    _position - <MARKER, OBJECT, LOCATION, GROUP, TASK, ARRAY>
     _radius   - random Radius (optional) <NUMBER>
 
 Example:
diff --git a/addons/diagnostic/fnc_error.sqf b/addons/diagnostic/fnc_error.sqf
@@ -14,7 +14,7 @@ Parameters:
     _title     - Title of the error <STRING>
     _message   - Error message (use "\n" for newline) <STRING>
     _file      - Name of file <STRING>
-    _lineNum   - Line of file <NUMEBR>
+    _lineNum   - Line of file <NUMBER>
 
 Returns:
     nil
diff --git a/addons/disposable/fnc_firedDisposable.sqf b/addons/disposable/fnc_firedDisposable.sqf
@@ -6,14 +6,14 @@ Description:
     Handles firing a disposable weapon.
 
 Parameters:
-    _unit       - Unit that fired the disposable weapon <OBEJCT>
+    _unit       - Unit that fired the disposable weapon <OBJECT>
     _launcher   - Disposable weapon <STRING>
     _muzzle     - Muzzle fired by the disposable weapon <STRING>
     _mode       - Current weapon mode of the disposable weapon <STRING>
     _ammo       - Ammo fired by the disposable weapon <STRING>
     _magazine   - Current magazine of the disposable weapon <STRING>
-    _projectile - Fired projectile <OBEJCT>
-    _unit       - Always same as element 0 <OBEJCT>
+    _projectile - Fired projectile <OBJECT>
+    _unit       - Always same as element 0 <OBJECT>
 
 Returns:
     Nothing.
diff --git a/addons/events/fnc_addBISPlayerEventHandler.sqf b/addons/events/fnc_addBISPlayerEventHandler.sqf
@@ -70,7 +70,7 @@ if (_key in GVAR(playerEventsHash)) exitWith { ERROR_1("bad key %1",_this); fals
 GVAR(playerEventsHash) set [_key, [_type, _code, _ignoreVirtual]];
 
 private _player = call CBA_fnc_currentUnit;
-if (_ignoreVirtual && {(unitIsUAV _player) || {getNumber (configOf _player >> "isPlayableLogic") == 1}}) exitWith {};
+if (_ignoreVirtual && {(unitIsUAV _player) || {getNumber (configOf _player >> "isPlayableLogic") == 1}}) exitWith { false };
 
 // Add event now
 private _newEH = _player addEventHandler [_type, _code];
diff --git a/addons/events/fnc_globalEvent.sqf b/addons/events/fnc_globalEvent.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _eventName - Type of event to publish. <STRING>
-    _params    - Parameters to pass to the event handlers. <ANY>
+    _params    - Parameters to pass to the event handlers. <ANY> (optional)
 
 Returns:
     None
diff --git a/addons/events/fnc_localEvent.sqf b/addons/events/fnc_localEvent.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _eventName - Type of event to publish. <STRING>
-    _params    - Parameters to pass to the event handlers. <ANY>
+    _params    - Parameters to pass to the event handlers. <ANY> (optional)
 
 Returns:
     _return - return value of the last added event function. <ANY>
diff --git a/addons/events/fnc_registerChatCommand.sqf b/addons/events/fnc_registerChatCommand.sqf
@@ -9,7 +9,7 @@ Parameters:
     _command      - Chat command <STRING>
     _code         - Code to execute after command was entered. <CODE>
     _availableFor - "all", "admin" or "adminLogged" (optional, default: "admin") <STRING>
-    _thisArgs     - Arguments to pass to event chat handler code <ANY>
+    _thisArgs     - Arguments to pass to event chat handler code <ANY> (optional, default: [])
 
 Returns:
     _return - true: Success, false: Error <BOOLEAN>
diff --git a/addons/events/fnc_remoteEvent.sqf b/addons/events/fnc_remoteEvent.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _eventName - Type of event to publish. <STRING>
-    _params    - Parameters to pass to the event handlers. <ANY>
+    _params    - Parameters to pass to the event handlers. <ANY> (optional)
 
 Returns:
     None
diff --git a/addons/events/fnc_serverEvent.sqf b/addons/events/fnc_serverEvent.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _eventName - Type of event to publish. <STRING>
-    _params    - Parameters to pass to the event handlers. <ANY>
+    _params    - Parameters to pass to the event handlers. <ANY> (optional)
 
 Returns:
     None
diff --git a/addons/events/fnc_targetEvent.sqf b/addons/events/fnc_targetEvent.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _eventName - Type of event to publish. <STRING>
-    _params    - Parameters to pass to the event handlers. <ANY>
+    _params    - Parameters to pass to the event handlers. <ANY> (optional)
     _targets   - Where to execute events. <OBJECT, GROUP, ARRAY>
 
 Returns:
diff --git a/addons/jr/fnc_compatibleItems.sqf b/addons/jr/fnc_compatibleItems.sqf
@@ -7,7 +7,7 @@ Description:
 
 Parameters:
     _weapon     - A weapons class name <STRING>
-    _typefilter - Optional filter. Can be "muzzle", "optic", "pointer" or "bipod". <STRING, NUMBER>
+    _typefilter - Optional filter. Can be "muzzle", "optic", "pointer" or "bipod". <STRING, NUMBER> (default: "")
 
 Returns:
     Class names of attachments compatible with weapon <ARRAY>
diff --git a/addons/keybinding/fnc_addKeybind.sqf b/addons/keybinding/fnc_addKeybind.sqf
@@ -45,18 +45,16 @@ Description:
 Parameters:
     _addon          - Name of the registering mod + optional sub-category <STRING, ARRAY>
     _action         - Id of the key action. <STRING>
-    _title          - Pretty name, or an array of pretty name and tooltip <STRING>
-    _downCode       - Code for down event, empty string for no code. <CODE>
-    _upCode         - Code for up event, empty string for no code. <CODE>
-
-Optional:
-    _defaultKeybind - The keybinding data in the format [DIK, [shift, ctrl, alt]] <ARRAY>
-    _holdKey        - Will the key fire every frame while down <BOOLEAN>
-    _holdDelay      - How long after keydown will the key event fire, in seconds. <NUMBER>
-    _overwrite      - Overwrite any previously stored default keybind <BOOLEAN>
+    _title          - Pretty name, or an array of pretty name and tooltip <STRING or ARRAY>
+    _downCode       - Code for down event, empty string for no code. <CODE or STRING>
+    _upCode         - Code for up event, empty string for no code. <CODE or STRING> (optional)
+    _defaultKeybind - The keybinding data in the format [DIK, [shift, ctrl, alt]] <ARRAY> (optional)
+    _holdKey        - Will the key fire every frame while down <BOOLEAN> (optional)
+    _holdDelay      - How long after keydown will the key event fire, in seconds. <NUMBER> (optional)
+    _overwrite      - Overwrite any previously stored default keybind <BOOLEAN> (optional)
 
 Returns:
-    Returns the current keybind for the action <ARRAY>
+    Returns the current keybind for the action <ARRAY> (or <NIL> on error)
 
 Examples:
     (begin example)
diff --git a/addons/keybinding/fnc_localizeKey.sqf b/addons/keybinding/fnc_localizeKey.sqf
@@ -7,9 +7,10 @@ Description:
 
 Parameters:
     _key     - DIK code <NUMBER>
-    _shift   - Shift pressed? <BOOL>
-    _control - Control pressed? <BOOL>
-    _alt     - Alt pressed? <BOOL>
+    _modifier - Modifier keys <ARRAY, BOOL> (optional)
+        _shift   - Shift pressed? <BOOL>
+        _control - Control pressed? <BOOL>
+        _alt     - Alt pressed? <BOOL>
 
 Returns:
     _keyName - Translated key <STRING>
diff --git a/addons/loadout/fnc_getLoadout.sqf b/addons/loadout/fnc_getLoadout.sqf
@@ -4,7 +4,7 @@ Function: CBA_fnc_getLoadout
 Description:
     Get a unit's extended loadout
 Parameters:
-    _unit - The unit to set the loadout on. <UNIT>
+    _unit - The unit to set the loadout on. <OBJECT>
 Returns:
     Extended Loadout <ARRAY>
 Examples:
diff --git a/addons/loadout/fnc_setLoadout.sqf b/addons/loadout/fnc_setLoadout.sqf
@@ -4,9 +4,9 @@ Function: CBA_fnc_setLoadout
 Description:
     Set a unit's extended loadout
 Parameters:
-    _unit - The unit to set the loadout on. <UNIT>
+    _unit - The unit to set the loadout on. <OBJECT>
     _loadout - The extended loadout to set. <ARRAY>
-    _fullMagazines - Partially emptied magazines will be refilled when the loadout is applied. <BOOL>
+    _fullMagazines - Partially emptied magazines will be refilled when the loadout is applied. <BOOL> (Default: false)
 Returns:
     Nothing
 Examples:
diff --git a/addons/music/fnc_getMusicData.sqf b/addons/music/fnc_getMusicData.sqf
@@ -11,7 +11,7 @@ Parameters:
     Default- what to return if nothing found
 
 Returns:
-    data entry for requested music class (or default if nothing found)
+    <ANY> data entry for requested music class (or default if nothing found)
 
 Example:
     (begin example)
diff --git a/addons/network/fnc_globalExecute.sqf b/addons/network/fnc_globalExecute.sqf
@@ -13,7 +13,7 @@ Parameters:
     _parameters - Parameter to pass in the _this variable. (optional) <ANY>
 
 Returns:
-    Magazine of the units binocular <STRING>
+    None
 
 Example:
     (begin example)
diff --git a/addons/settings/fnc_addSetting.sqf b/addons/settings/fnc_addSetting.sqf
@@ -10,7 +10,7 @@ Parameters:
     _settingType - Type of setting. Can be "CHECKBOX", "EDITBOX", "LIST", "SLIDER", "COLOR" or "TIME" <STRING>
     _title       - Display name or display name + tooltip (optional, default: same as setting name) <STRING, ARRAY>
     _category    - Category for the settings menu + optional sub-category <STRING, ARRAY>
-    _valueInfo   - Extra properties of the setting depending of _settingType. See examples below <ANY>
+    _valueInfo   - Extra properties of the setting depending of _settingType. See examples below (optional) <ANY>
     _isGlobal    - 1: all clients share the same setting, 2: setting can't be overwritten (optional, default: 0) <BOOL, NUMBER>
     _script      - Script to execute when setting is changed. (optional) <CODE>
     _needRestart - Setting will be marked as needing mission restart after being changed. (optional, default false) <BOOL>
diff --git a/addons/settings/fnc_init.sqf b/addons/settings/fnc_init.sqf
@@ -10,7 +10,7 @@ Parameters:
     _settingType - Type of setting. Can be "CHECKBOX", "EDITBOX", "LIST", "SLIDER", "COLOR" or "TIME" <STRING>
     _title       - Display name or display name + tooltip (optional, default: same as setting name) <STRING, ARRAY>
     _category    - Category for the settings menu + optional sub-category <STRING, ARRAY>
-    _valueInfo   - Extra properties of the setting depending of _settingType. See examples below <ANY>
+    _valueInfo   - Extra properties of the setting depending of _settingType. See examples below (optional) <ANY>
     _isGlobal    - 1: all clients share the same setting, 2: setting can't be overwritten (optional, default: 0) <BOOL, NUMBER>
     _script      - Script to execute when setting is changed. (optional) <CODE>
     _needRestart - Setting will be marked as needing mission restart after being changed. (optional, default false) <BOOL>
diff --git a/addons/statemachine/fnc_createFromConfig.sqf b/addons/statemachine/fnc_createFromConfig.sqf
@@ -11,7 +11,7 @@ Parameters:
                       <CONFIG>
 
 Returns:
-    _stateMachine   - a state machine <LOCATION>
+    _stateMachine   - a state machine <LOCATION> (or <NIL> if config was invalid)
 
 Examples:
     (begin example)
diff --git a/addons/statemachine/fnc_manualTransition.sqf b/addons/statemachine/fnc_manualTransition.sqf
@@ -10,10 +10,8 @@ Parameters:
     _stateMachine   - a state machine <LOCATION>
     _thisOrigin     - state the transition origins from <STRING>
     _thisTarget     - state the transition goes to <STRING>
-    _onTransition   - code that gets executed once transition happens <CODE>
-                      (Default: {})
-    _thisTransition - name for this specific transition <STRING>
-                      (Default: "MANUAL")
+    _onTransition   - code that gets executed once transition happens <CODE> (Default: {})
+    _thisTransition - name for this specific transition <STRING> (Default: "MANUAL")
 
 Returns:
     Nothing
diff --git a/addons/ui/fnc_addItemContextMenuOption.sqf b/addons/ui/fnc_addItemContextMenuOption.sqf
diff --git a/addons/ui/fnc_openItemContextMenu.sqf b/addons/ui/fnc_openItemContextMenu.sqf
diff --git a/addons/ui/fnc_removeItemContextMenuOption.sqf b/addons/ui/fnc_removeItemContextMenuOption.sqf
diff --git a/addons/ui/fnc_renameInventoryItem.sqf b/addons/ui/fnc_renameInventoryItem.sqf
