Conform function headers to coding guidelines (#5255)

* Fixed headers to work with silentspike python script

* Fixed rest of the files

* Fixed ace-team

addons/common/functions/fnc_ASLToPosition.sqf

@@ -10,6 +10,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [1, 2, 3] call ace_common_fnc_ASLToPosition
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc__handleRequestAllSyncedEvents.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Event is successed <BOOL>
  *
+ * Example:
+ * [bob] call ace_common_fnc__handleRequestAllSyncedEvents
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc__handleRequestSyncedEvent.sqf

@@ -2,17 +2,21 @@
  * Author: jaynus
  * Receives either requests for synchronization from clients, or the synchronization data from the server.
  *
- * Arguments [Client] :
+ * Arguments [Client]:
  * 0: eventName <STRING>
  * 1: eventLog <ARRAY>
  *
- * Arguments [Server] :
+ * Arguments [Server]:
  * 0: eventName <STRING>
  * 1: client <OBJECT>
  *
  * Return Value:
  * Event is successed <BOOL>
  *
+ * Example:
+ * ["name", [LOG]] call ace_common_fnc__handleRequestSyncedEvent //Client
+ * ["name", bob] call ace_common_fnc__handleRequestSyncedEvent//Server
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc__handleSyncedEvent.sqf

@@ -2,7 +2,7 @@
  * Author: jaynus
  * Handles synced events being received. Server will log them, and server/client will execute them.
  *
- * Arguments [Client] :
+ * Arguments: [Client]
  * 0: eventName <STRING>
  * 1: arguments <ARRAY>
  * 2: ttl <NUMBER>
@@ -10,6 +10,9 @@
  * Return Value:
  * Boolean of success <BOOL>
  *
+ * Example:
+ * [bob] call ace_common_fnc__handleSyncedEvent
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_addActionEventHandler.sqf

@@ -11,6 +11,9 @@
  * Return Value:
  * ID of the action (used to remove it later) <NUMBER>
  *
+ * Example:
+ * [bob, "DefaultAction", "condition", "execute"] call ace_common_fnc_addActionEventHandler
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_addActionMenuEventHandler.sqf

@@ -15,6 +15,9 @@
  * Return Value:
  * ID of the action (used to remove it later) <NUMBER>
  *
+ * Example:
+ * [bob, "Title", "DefaultAction", "condition", "execute", "conditionmenu", "executemenu", 5] call ace_common_fnc_addActionMenuEventHandler
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_addCanInteractWithCondition.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * ["ID", {Condition}] call ace_common_fnc_addCanInteractWithCondition
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_addLineToDebugDraw.sqf

@@ -8,7 +8,7 @@
  * 2: Color <ARRAY>
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * [[0,0,0], [1,1,0], [1,0,0,1]]] call ace_common_fnc_addLineToDebugDraw;

addons/common/functions/fnc_addMapMarkerCreatedEventHandler.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * ID of the event script (used to remove it later). <NUMBER>
  *
+ * Example:
+ * ["bob"] call ace_common_fnc_addMapMarkerCreatedEventHandler
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_addSetting.sqf

@@ -16,6 +16,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * ["bob", "type", true, "bob", "person", [1,2,3], true, 5] call ace_common_fnc_addSettings
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_addToInventory.sqf

@@ -12,6 +12,9 @@
  * 0: Added to player <BOOL>
  * 1: weaponholder <OBJECT>
  *
+ * Example:
+ * [bob, "classname", "", 5] call ace_common_fnc_addToInventory
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_ambientBrightness.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Ambient brightness <NUMBER>
  *
+ * Example:
+ * [] call ace_common_fnc_ambientBrightness
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_arithmeticGetResult.sqf

@@ -8,7 +8,7 @@
  * 2: Operation (sum, product, min, max, avg) <STRING>
  *
  * Return Value:
- * <NUMBER>
+ * Value <NUMBER>
  *
  * Example:
  * [ace_player, "ace_aimCoefficents", "product"] call ace_common_fnc_arithmeticGetResult

addons/common/functions/fnc_arithmeticSetSource.sqf

@@ -9,7 +9,7 @@
  * 3: Code that returns a number (can access var _namespace) [use {} to remove] <CODE>
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * [missionNameSpace, "ace_hearing", "myMission", {0.5}] call ace_common_fnc_arithmeticSetSource

addons/common/functions/fnc_assignedItemFix.sqf

@@ -8,7 +8,10 @@
  * Return Value:
  * None
  *
- * Public : No
+ * Example:
+ * call ace_common_fnc_assignedItemFix
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 

addons/common/functions/fnc_binarizeNumber.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * Booleans <ARRAY>
  *
+ * Example:
+ * [5, 5] call ace_common_fnc_binarizeNumber
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_blurScreen.sqf

@@ -4,7 +4,7 @@
  *
  * Arguments:
  * 0: ID <NUMBER>
- * 1: Show? <BOOL/NUMBER>
+ * 1: Show? <BOOL, NUMBER>
  *
  * Return Value:
  * None

addons/common/functions/fnc_cachedCall.sqf

@@ -13,6 +13,9 @@
  * Return Value:
  * Result of the function <ANY>
  *
+ * Example:
+ * [[array]], {dothings}, NAMESPACE, "UID", 5, "clear"] call ace_common_fnc_cachedCall
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_canGetInPosition.sqf

@@ -7,12 +7,14 @@
  * 1: The vehicle to be entered <OBJECT>
  * 2: Position. Can be "Driver", "Pilot", "Gunner", "Commander", "Copilot", "Turret", "FFV", "Codriver" or "Cargo" <STRING>
  * 3: Check current distance to vehicles memory point? (default: false) <BOOL>
- * 4: Index. "Turret", "FFV", "Codriver" and "Cargo" support this optional parameter. Which position should be taken.
- *    Note: This index is diffrent from Armas "cargoIndex". (default: next free index) <NUMBER>
+ * 4: Index. "Turret", "FFV", "Codriver" and "Cargo" support this optional parameter. Which position should be taken. Note: This index is different from Armas "cargoIndex". (default: next free index) <NUMBER>
  *
  * Return Value:
  * None
  *
+ * Example:
+ * [bob, car, "Pilot", true, "Turret"] call ace_common_fnc_canGetInPosition
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_canInteractWith.sqf

@@ -8,7 +8,10 @@
  * 2: Exceptions. What general conditions are to skip? (default: []) <ARRAY>
  *
  * Return Value:
- * Unit can interact?
+ * Unit can interact? <BOOL>
+ *
+ * Example:
+ * [bob, target, []] call ace_common_fnc_canInteractWith
  *
  * Public: Yes
  */

addons/common/functions/fnc_changeProjectileDirection.sqf

@@ -11,6 +11,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [bullet, 2, 5, 3] call ace_common_fnc_changeProjectileDirection
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_checkFiles.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * call ace_common_fnc_checkFiles
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_checkPBOs.sqf

@@ -14,6 +14,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [0, false, ""] call ace_common_fnc_checkPBOs
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_claim.sqf

@@ -10,6 +10,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [bob, flag, true] call ace_common_fnc_claim
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_codeToString.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Code <STRING>
  *
+ * Example:
+ * ["bob"] call ace_common_fnc_codeToString
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_createOrthonormalReference.sqf

@@ -2,7 +2,7 @@
  * Author: esteldunedain
  * Returns a orthonormal system of reference aligned with the supplied vector
  *
- * Arguments: 
+ * Arguments:
  * Vector to align the coordinate system with <ARRAY>
  *
  * Return Value:
@@ -10,6 +10,9 @@
  * 1: Normalized Cross Product Vector <ARRAY>
  * 2: Vector Cross Product <ARRAY>
  *
+ * Example:
+ * [[0,0,0]] call ace_common_fnc_createOrthonormalReference
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_currentChannel.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * The current channel ("group", "side", "global", "command", "vehicle", "direct", "custom_X") <STRING>
  *
+ * Example:
+ * [] call ace_common_fnc_currentChannel
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_debug.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * Message is Printed <BOOL>
  *
+ * Example:
+ * [bob, 2] call ace_common_fnc_debug
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_debugModule.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * call ace_common_fnc_debugModule
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_defineVariable.sqf

@@ -13,6 +13,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * ["bob", 1, true, "category", 1, true] call ace_common_fnc_defineVariable
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_deviceKeyFindValidIndex.sqf

@@ -3,7 +3,7 @@
  * Finds next valid index for the device array.
  *
  * Arguments:
- * 0: Offset from currentIndex (use 1 to find next valid after current) or a displayName string (default: 0)<STRING, NUMBER>
+ * 0: Offset from currentIndex (use 1 to find next valid after current) or a displayName string (default: 0) <STRING, NUMBER>
  *
  * Return Value:
  * The new index (-1 if no valid) <NUMBER>

addons/common/functions/fnc_disableUserInput.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [true] call ace_common_fnc_disableUserInput
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_displayText.sqf

@@ -11,6 +11,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * ["Message", true, 5, 2] call ace_common_fnc_displayText
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_dropBackpack.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Ground wepaon holder with backpack <OBJECT>
  *
+ * Example:
+ * [unit] call ace_common_fnc_dropBackpack
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_dumpPerformanceCounters.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * call ace_common_fnc_dumpPerformanceCounters
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_endRadioTransmission.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * call ace_common_fnc_endRadioTransmission
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_eraseCache.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [NAMESPACE, "UID"] call ace_common_fnc_eraseCache
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_errorMessage.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * call ace_common_fnc_errorMessage
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_firedEH.sqf

@@ -14,6 +14,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [bob, "gun", "muzzle", "single", "ammo", "magazine", "bullet"] call ace_common_fnc_firedEH
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_fixCollision.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [bob] call ace_common_fnc_fixCollision
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_fixFloating.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [object] call ace_common_fnc_fixFloating
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_fixLoweredRifleAnimation.sqf

@@ -6,7 +6,7 @@
  * 0: Unit <OBJECT>
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * [ACE_player] call ace_common_fnc_fixLoweredRifleAnimation

addons/common/functions/fnc_fixPosition.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [bob] call ace_common_fnc_fixPosition
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getAllDefinedSetVariables.sqf

@@ -14,6 +14,9 @@
  *   3: publicFlag <BOOL>
  *   4: peristentFlag <BOOL>
  *
+ * Example:
+ * [bob, ""] call ace_common_fnc_getAllDefinedSetVariables
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getChildren.sqf

@@ -7,6 +7,9 @@
  *
  * Return Value:
  * Parent Entry Class Children <ARRAY>
+
+ * Example:
+ * [bob] call ace_common_fnc_getChildren
  *
  * Public: Yes
  */

addons/common/functions/fnc_getConfigCommander.sqf

@@ -7,6 +7,9 @@
  *
  * Return Value:
  * Commander config <CONFIG>
+
+ * Example:
+ * [car] call ace_common_fnc_getConfigCommander
  *
  * Public: Yes
  */

addons/common/functions/fnc_getConfigGunner.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Gunner config <CONFIG>
  *
+ * Example:
+ * [car] call ace_common_fnc_getConfigGunner
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getDefinedVariable.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * Value of variable or default value, if the variable is undefined <ANY>
  *
+ * Example:
+ * [bob, "var"] call ace_common_fnc_getDefinedVariable
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getDefinedVariableDefault.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Default value of variable <ANY>
  *
+ * Example:
+ * ["name"] call ace_common_fnc_getDefinedVariableDefault
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getDefinedVariableInfo.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Variable Metadata <ARRAY>
  *
+ * Example:
+ * ["var"] call ace_common_fnc_getDefinedVariableInfo
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getDisplayConfigName.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Display Classnames <ARRAY>
  *
+ * Example:
+ * [5] call ace_common_fnc_getDisplayConfigName
+ *
  * Public: Yes
  *
  * Note: Really slow due to iteration through whole config. Meant for debugging.

addons/common/functions/fnc_getDoorTurrets.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * All turret indecies of the Vehicle <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getDoorTurrets
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getFirstObjectIntersection.sqf

@@ -11,6 +11,9 @@
  * 0: Intersects <BOOL>
  * 1: Intersection Position ASL <ARRAY>
  *
+ * Example:
+ * [[1,2,3], [0,0,5], 5] call ace_common_fnc_getFirstObjectIntersection
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getFirstTerrainIntersection.sqf

@@ -11,6 +11,9 @@
  * 0: Intersects <BOOL>
  * 1: Intersection Position ASL <ARRAY>
  *
+ * Example:
+ * [[1,2,3], [0,0,5], 5] call ace_common_fnc_getFirstTerrainIntersection
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getGunner.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * Gunner <OBJECT>
  *
+ * Example:
+ * [car, "gun"] call ace_common_fnc_getGunner
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getInPosition.sqf

@@ -1,16 +1,19 @@
 /*
  * Author: commy2
  * Move unit into given vehicle position or switch to that position if the unit is already inside the vehicle.
-  *
-  * Arguments:
+ *
+ * Arguments:
  * 0: Unit <OBJECT>
  * 1: Vehicle <OBJECT>
  * 2: Position ("Driver", "Pilot", "Gunner", "Commander", "Copilot", "Turret", "FFV", "Codriver", "Cargo") <STRING>
  * 3: Index (only applies to "Turret", "FFV", "Codriver", "Cargo") (default: next free index) <NUMBER>
-  *
-  * Return Value:
+ *
+ * Return Value:
  * None
  *
+ * Example:
+ * [unit, vehicle, "Driver", 5] call ace_common_fnc_getInPosition
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getItemType.sqf

@@ -9,6 +9,9 @@
  * 0: Type ("weapon", "item", "magazine", "") <STRING>
  * 1: Item Description <STRING>
  *
+ * Example:
+ * ["tire"] call ace_common_fnc_getItemType
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getLightProperties.sqf

@@ -13,6 +13,9 @@
  * 3: Light inner angle <NUMBER>
  * 4: Light outer angle <NUMBER>
  *
+ * Example:
+ * [car, "light"] call ace_common_fnc_getLightProperties
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getLightPropertiesWeapon.sqf

@@ -12,6 +12,9 @@
  * 3: Light inner angle <NUMBER>
  * 4: Light outer angle <NUMBER>
  *
+ * Example:
+ * ["flashlight"] call ace_common_fnc_getLightPropertiesWeapon
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getMGRSdata.sqf

@@ -12,6 +12,9 @@
  * 1: 100km square <STRING>
  * 2: GZD + 100km sq. as a single string <STRING>
  *
+ * Example:
+ * ["worldName"] call ace_common_fnc_getMGRSdata
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getMapData.sqf

@@ -9,6 +9,9 @@
  * 0: Latitude <NUMBER>
  * 1: Altitude <NUMBER>
  *
+ * Example:
+ * ["altis"] call ace_common_fnc_getMapData
+ *
  * Public: No
  */
 

addons/common/functions/fnc_getMapPosFromGrid.sqf

@@ -6,7 +6,7 @@
  * 0: Grid Cords <STRING>
  * 1: Grid center (true), Grid Bottom Right (false) (default: true) <BOOL>
  *
- * Return values:
+ * Return Value:
  * Position <ARRAY>
  *
  * Example:

addons/common/functions/fnc_getMarkerType.sqf

@@ -3,11 +3,14 @@
  * Get the apropriate marker for a group.
  *
  * Arguments:
- * 0: Group
+ * 0: Group <GROUP>
  *
  * Return Value:
  * Marker Type <STRING>
  *
+ * Example:
+ * ["GROUP"] call ace_common_fnc_getmarkerType
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getNumberMagazinesIn.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * Magazine amount <NUMBER>
  *
+ * Example:
+ * [bob, "magazine"] call ace_common_fnc_getNumberMagazinesIn
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getPitchBankYaw.sqf

@@ -10,6 +10,9 @@
  * 1: bank <NUMBER>
  * 2: yaw <NUMBER>
  *
+ * Example:
+ * [plane] call ace_common_fnc_getPitchBankYaw
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getReflectorsWithSelections.sqf

@@ -12,6 +12,9 @@
  * 0: Light Hitpoints <ARRAY>
  * 1: Selections <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getReflectorsWithSelections
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getSelectionsWithoutHitPoints.sqf

@@ -4,10 +4,15 @@
  * Returns all damageable selections without hitpoints of any vehicle.
  *
  * Arguments:
- * 0: A vehicle, not the classname (Object)
+ * 0: A vehicle, not the classname <OBJECT>
  *
  * Return Value:
- * The selections without hitpoints, i.e. reflectors. (Array)
+ * The selections without hitpoints, i.e. reflectors. <ARRAY>
+ *
+ * Example:
+ * [car] call ace_common_fnc_getSelectionsWithoutHitPoints
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 

addons/common/functions/fnc_getSettingData.sqf

@@ -6,7 +6,7 @@
  * 0: Setting Name <STRING>
  *
  * Return Value:
- * Setting Data (Array)
+ * Setting Data <ARRAY>
  * 0: Name <STRING>
  * 1: Type Name <STRING>
  * 2: Is Client Settable <BOOL>
@@ -17,6 +17,9 @@
  * 7: Default Value <ANY>
  * 8: Localized Category <STRING>
  *
+ * Example:
+ * ["setting"] call ace_common_fnc_getSettingData
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getStaminaBarControl.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Stamina Bar control <CONTROL>
  *
+ * Example:
+ * call ace_common_fnc_getStaminaBarControl
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTargetAzimuthAndInclination.sqf

@@ -9,6 +9,9 @@
  * 0: Azimuth <NUMBER>
  * 1: Inclination <NUMBER>
  *
+ * Example:
+ * [] call ace_common_fnc_getTargetAzimuthAndInclination
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTargetDistance.sqf

@@ -10,6 +10,9 @@
  * Return Value:
  * Distance in meters <NUMBER>
  *
+ * Example:
+ * [5,20000,56] call ace_common_fnc_getTargetDistance
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTargetObject.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Nearest object in line of sight, objNull if none are found <OBJECT>
  *
+ * Example:
+ * [56] call ace_common_fnc_getTargetObject
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTurnedOnLights.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * All burning lights <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getTurnedOnLights
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTurretCommander.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Vehicle commander turrent indecies <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getTurretCommander
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTurretConfigPath.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * Turret config <CONFIG>
  *
+ * Example:
+ * [CfgVehicle, [Array]] call ace_common_fnc_getTurretConfigPath
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTurretCopilot.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Vehicle Copilot Turret indecies <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getTurretCopilot
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTurretDirection.sqf

@@ -10,6 +10,9 @@
  * 0: Position ASL <ARRAY>
  * 1: Direction <ARRAY>
  *
+ * Example:
+ * [car, [5,6,5]] call ace_common_fnc_getTurretDirection
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTurretGunner.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Vehicle Gunner Turret indecies <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getTurretGunner
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTurretsFFV.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Vehicle FFV Turret indecies <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getTurretsFFV
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getTurretsOther.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Vehicle Other Turret indecies <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getTurretsOther
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getVehicleCargo.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Vehicle cargo positions <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getVehicleCargo
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getVehicleCodriver.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Vehicle codriver positions <ARRAY>
  *
+ * Example:
+ * ["car"] call ace_common_fnc_getVehicleCodriver
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getVehicleCrew.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * Crew <ARRAY>
  *
+ * Example:
+ * [car, ["driver"]] call ace_common_fnc_getVehicleCrew
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getVehicleUAVCrew.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * UAV Dummy Crew <ARRAY>
  *
+ * Example:
+ * [car] call ace_common_fnc_getVehicleUAVCrew
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getVersion.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * ACE Version <STRING>
  *
+ * Example:
+ * [] call ace_common_fnc_getVersion
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getWeaponAzimuthAndInclination.sqf

@@ -9,6 +9,9 @@
  * 0: Azimuth <NUMBER>
  * 1: Inclination <NUMBER>
  *
+ * Example:
+ * ["gun"] call ace_common_fnc_getWeaponAzimuthAndInclination
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getWeaponIndex.sqf

@@ -13,6 +13,9 @@
  *   2 = handgun
  *  -1 = other
  *
+ * Example:
+ * [bob, "gun"] call ace_common_fnc_getWeaponIndex
+ *
  * Public: Yes
  */
  #include "script_component.hpp"

addons/common/functions/fnc_getWeaponModes.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Firing Modes <ARRAY>
  *
+ * Example:
+ * ["gun"] call ace_common_fnc_getWeaponModes
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getWeaponMuzzles.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * All weapon muzzles <ARRAY>
  *
+ * Example:
+ * ["gun"] call ace_common_fnc_getWeaponMuzzles
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getWeaponState.sqf

@@ -12,6 +12,9 @@
  * 2: Magazines <ARRAY>
  * 3: Ammo <ARRAY>
  *
+ * Example:
+ * [bob, "gun"] call ace_common_fnc_getWeaponState
+ *
  * Public: Yes
  */
 #include "script_component.hpp"
@@ -42,4 +45,4 @@ private _ammo = _muzzles apply {0};
     false
 } count magazinesAmmoFull _unit;
 
-[_attachments, _muzzles, _magazines, _ammo]; 
+[_attachments, _muzzles, _magazines, _ammo];

addons/common/functions/fnc_getWeaponType.sqf

@@ -12,6 +12,9 @@
  *   3 = handgun
  *  -1 = other
  *
+ * Example:
+ * ["gun"] call ace_common_fnc_getWeaponType
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getWindDirection.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Wind cardinal direction <STRING>
  *
+ * Example:
+ * [] call ace_common_fnc_getWindDirection
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_getZoom.sqf

@@ -8,10 +8,13 @@
  * Return Value:
  * Zoom <NUMBER>
  *
+ * Example:
+ * [] call ace_common_fnc_getZoom
+ *
  * Public: Yes
  */
 #include "script_component.hpp"
 
 if (!hasInterface) exitWith {0};
 
-(0.5 - ((worldToScreen positionCameraToWorld [0, 1, 1]) select 1)) * (getResolution select 5) 
+(0.5 - ((worldToScreen positionCameraToWorld [0, 1, 1]) select 1)) * (getResolution select 5)

addons/common/functions/fnc_goKneeling.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [bob] call ace_common_fnc_goKneeling
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_hadamardProduct.sqf

@@ -10,6 +10,9 @@
  * Return Value:
  * Hadamard Product <ARRAY>
  *
+ * Example:
+ * [[0,0,0], [1,1,1]] call ace_common_fnc_hadamardProduct
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_handleEngine.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [bob, "running"] call ace_common_fnc_handleEngine
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/common/functions/fnc_handleModifierKey.sqf

@@ -8,7 +8,10 @@
  * Return Value:
  * None
  *
- * Public : No
+ * Example:
+ * call ace_common_fnc_handleModifierKey
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 

addons/common/functions/fnc_handleModifierKeyUp.sqf

@@ -8,7 +8,10 @@
  * Return Value:
  * None
  *
- * Public : No
+ * Example:
+ * call ace_common_fnc_handleModifierKeyUp
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 

addons/common/functions/fnc_hasHatch.sqf

@@ -8,6 +8,9 @@
  * Return Value:
  * Unit has a hatch? <BOOL>
  *
+ * Example:
+ * [bob] call ace_common_fnc_hasHatch
+ *
  * Public: Yes
  */
 #include "script_component.hpp"

addons/common/functions/fnc_hasItem.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * has Item <BOOL>
  *
+ * Example:
+ * [[bob, "item"] call ace_common_fnc_hasItem
+ *
  * Public: yes
  *
  * Note: Case sensitive