Conform function headers to coding guidelines (#5255)

* Fixed headers to work with silentspike python script

* Fixed rest of the files

* Fixed ace-team

addons/advanced_ballistics/functions/fnc_calculateAmmoTemperatureVelocityShift.sqf

@@ -10,6 +10,9 @@
  * Return Value:
  * muzzle velocity shift - m/s <NUMBER>
  *
+ * Example:
+ * [[], 5] call ace_advanced_ballistics_fnc_calcilateAmmoTemperatureVelocityShift
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/advanced_ballistics/functions/fnc_calculateAtmosphericCorrection.sqf

@@ -13,6 +13,9 @@
  * Return Value:
  * corrected ballistic coefficient <NUMBER>
  *
+ * Example:
+ * [2, 5, 5, 0.5, "ASM"] call ace_advanced_ballistics_fnc_calculateAtmosphericCorrection
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/advanced_ballistics/functions/fnc_calculateBarrelLengthVelocityShift.sqf

@@ -4,14 +4,17 @@
  * Calculates the muzzle velocity shift caused by different barrel lengths
  *
  * Arguments:
- * 0: barrel length - mm
+ * 0: barrel length - mm <NUMBER>
  * 1: muzzle velocity lookup table - m/s <ARRAY>
  * 2: barrel length lookup table - mm <ARRAY>
  * 3: muzzle velocity - m/s <NUMBER>
  *
  * Return Value:
  * muzzle velocity shift - m/s <NUMBER>
  *
+ * Example:
+ * [5, [0,5], [0,5], 5] call ace_advanced_ballistics_fnc_calculateBarrelLengthVelocityShift
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/advanced_ballistics/functions/fnc_calculateRetardation.sqf

@@ -11,6 +11,9 @@
  * Return Value:
  * retardation - m/(s^2) <NUMBER>
  *
+ * Example:
+ * [5, 20, 10] call ace_advanced_ballistics_fnc_calculateRetardation
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/advanced_ballistics/functions/fnc_calculateStabilityFactor.sqf

@@ -15,6 +15,9 @@
  * Return Value:
  * stability factor <NUMBER>
  *
+ * Example:
+ * [1, 2, 3, 4, 5, 6, 7] call ace_advanced_ballistics_fnc_calculateStabilityFactor
+ *
  * Public: No
  */
 #include "script_component.hpp"

addons/advanced_ballistics/functions/fnc_diagnoseWeapons.sqf

@@ -10,6 +10,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [] call ace_advanced_ballistics_fnc_diagnoseWeapons
+ *
  * Public: No
  */
 #define DEBUG_MODE_FULL

addons/advanced_ballistics/functions/fnc_displayProtractor.sqf

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

addons/advanced_ballistics/functions/fnc_handleFirePFH.sqf

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

addons/advanced_ballistics/functions/fnc_handleFired.sqf

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

addons/advanced_ballistics/functions/fnc_initModuleSettings.sqf

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

addons/advanced_ballistics/functions/fnc_initializeTerrainExtension.sqf

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

addons/advanced_ballistics/functions/fnc_readAmmoDataFromConfig.sqf

@@ -7,18 +7,21 @@
  * ammo - classname <STRING>
  *
  * Return Value:
- * 0: _airFriction
- * 1: _caliber
- * 2: _bulletLength
- * 3: _bulletMass
- * 4: _transonicStabilityCoef
- * 5: _dragModel
- * 6: _ballisticCoefficients
- * 7: _velocityBoundaries
- * 8: _atmosphereModel
- * 9: _ammoTempMuzzleVelocityShifts
- * 10: _muzzleVelocityTable
- * 11: _barrelLengthTable
+ * 0: _airFriction <NUMBER>
+ * 1: _caliber <NUMBER>
+ * 2: _bulletLength <NUMBER>
+ * 3: _bulletMass <NUMBER>
+ * 4: _transonicStabilityCoef <NUMBER>
+ * 5: _dragModel <NUMBER>
+ * 6: _ballisticCoefficients <NUMBER>
+ * 7: _velocityBoundaries <NUMBER>
+ * 8: _atmosphereModel <NUMBER>
+ * 9: _ammoTempMuzzleVelocityShifts <NUMBER>
+ * 10: _muzzleVelocityTable <NUMBER>
+ * 11: _barrelLengthTable <NUMBER>
+ *
+ * Example:
+ * ["ammo"] call ace_advanced_ballistics_fnc_readAmmoDataFromConfig
  *
  * Public: No
  */

addons/advanced_ballistics/functions/fnc_readWeaponDataFromConfig.sqf

@@ -7,9 +7,12 @@
  * weapon - classname <STRING>
  *
  * Return Value:
- * 0: _barrelTwist
- * 1: _twistDirection
- * 2: _barrelLength
+ * 0: _barrelTwist <NUMBER>
+ * 1: _twistDirection <NUMBER>
+ * 2: _barrelLength <NUMBER>
+ *
+ * Example:
+ * ["weapon"] call ace_advanced_ballistics_fnc_readWeaponDataFromConfig
  *
  * Public: No
  */

addons/advanced_fatigue/functions/fnc_addDutyFactor.sqf

@@ -8,6 +8,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * ["ID", 5] call ace_advanced_fatigue_fnc_addDutyFactor
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 params [["_id", "", [""]], ["_factor", 1, [0, {}]]];

addons/advanced_fatigue/functions/fnc_createStaminaBar.sqf

@@ -7,6 +7,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [DISPLAY] call ace_advanced_fatigue_fnc_createStaminaBar
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 params ["_display"];

addons/advanced_fatigue/functions/fnc_handlePlayerChanged.sqf

@@ -8,6 +8,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [newbob, oldbob] call ace_advanced_fatigue_fnc_handlePlayerChanged
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 params ["_newUnit", "_oldUnit"];

addons/advanced_fatigue/functions/fnc_handleStaminaBar.sqf

@@ -7,6 +7,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [0.5] call ace_advanced_fatigue_fnc_handleStaminaBar
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 params ["_stamina"];

addons/advanced_fatigue/functions/fnc_mainLoop.sqf

@@ -7,6 +7,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [] call ace_advanced_fatigue_fnc_mainLoop
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 if (!alive ACE_player) exitWith { // Dead people don't breath, Will also handle null (Map intros)

addons/advanced_fatigue/functions/fnc_moduleSettings.sqf

@@ -7,6 +7,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [MODULE] call ace_advanced_fatigue_fnc_moduleSettings
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 params ["_logic"];

addons/advanced_fatigue/functions/fnc_removeDutyFactor.sqf

@@ -7,6 +7,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * ["ID"] call ace_advanced_fatigue_fnc_removeDutyFactor
+ *
+ * Public: No
  */
 #include "script_component.hpp"
 params [["_id", "", [""]]];

addons/advanced_throwing/functions/fnc_moduleInit.sqf

@@ -13,8 +13,7 @@
  * Example:
  * [logic, [unit1, unit2], true] call ace_advanced_throwing_fnc_moduleInit
  *
- * Public:
- * No
+ * Public: No
  */
 #include "script_component.hpp"
 

addons/advanced_throwing/functions/fnc_renderPickUpInteraction.sqf

@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * call ace_advanced_throwing_fnc_renderPickUpInteraction

addons/atragmx/functions/fnc_add_new_gun.sqf

@@ -6,7 +6,7 @@
  * Nothing
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * call ace_atragmx_fnc_add_new_gun

addons/atragmx/functions/fnc_calculate_distance_at_velocity.sqf

@@ -3,10 +3,10 @@
  * Calculates distance at which the bullet velocity drops below the threshold velocity
  *
  * Arguments:
- * theshold velocity <number>
+ * theshold velocity <NUMBER>
  *
  * Return Value:
- * distance <number
+ * distance <NUMBER>
  *
  * Example:
  * 403 call ace_atragmx_fnc_calculate_distance_at_velocity

addons/atragmx/functions/fnc_calculate_range_card.sqf

@@ -3,10 +3,10 @@
  * Calculates the range card output based on the current data set
  *
  * Arguments:
- * Nothing
+ * None
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * call ace_atragmx_fnc_calculate_range_card

addons/atragmx/functions/fnc_calculate_target_range_assist.sqf

@@ -3,10 +3,10 @@
  * Calculates the target range and updates the output fields
  *
  * Arguments:
- * Nothing
+ * None
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * call ace_atragmx_fnc_calculate_target_range_assist
@@ -74,7 +74,7 @@ switch (_this) do {
         if (_estRange > 0) then {
             _imageSize = atan(_targetSize / _estRange);
         };
-        
+
         switch (GVAR(rangeAssistImageSizeUnit)) do {
             case 0: {
                 _imageSize = _imageSize * 6400 / 360;
@@ -93,7 +93,7 @@ switch (_this) do {
         if (tan(_imageSize) != 0) then {
             _estRange = _targetSize / tan(_imageSize);
         };
-        
+
         ctrlSetText [7013, Str(Round(_estRange))];
     };
 };

addons/atragmx/functions/fnc_calculate_target_solution.sqf

@@ -3,10 +3,10 @@
  * Calculates the fireing solution and updates the result input/output fields
  *
  * Arguments:
- * Nothing
+ * None
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * call ace_atragmx_fnc_calculate_target_solution

addons/atragmx/functions/fnc_calculate_target_speed_assist.sqf

@@ -3,10 +3,10 @@
  * Calculates the target speed and updates the output fields
  *
  * Arguments:
- * Nothing
+ * None
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * call ace_atragmx_fnc_calculate_target_speed_assist

addons/atragmx/functions/fnc_calculate_truing_drop.sqf

@@ -6,7 +6,7 @@
  * parse input <BOOL>
  *
  * Return Value:
- * Nothing
+ * None
  *
  * Example:
  * call ace_atragmx_fnc_calculate_truing_drop
@@ -33,7 +33,7 @@ if (_parseInput) then {
     _subsonicRange  = Round(_subsonicRange);
 
     _subsonicRange = _transonicRange max _subsonicRange;
-    
+
     _transonicDrop = -100 max parseNumber(ctrlText 18013) min 100;
     _subsonicDrop = -100 max parseNumber(ctrlText 18014) min 100;
     private _dropUnit = GVAR(currentScopeUnit);
@@ -56,7 +56,7 @@ if (_parseInput) then {
     };
     _transonicDrop = Round(_transonicDrop * 100) / 100;
     _subsonicDrop  = Round(_subsonicDrop  * 100) / 100;
-    
+
     _subsonicDrop = _transonicDrop max _subsonicDrop;
 };
 
@@ -65,7 +65,7 @@ if ((GVAR(truingDropDropData) select 0) == 0 || {!([_transonicRange, _subsonicRa
         call FUNC(calculate_target_solution);
     };
     private _solutionInput = +GVAR(targetSolutionInput);
-    
+
     if (_transonicRange == 0) then {
         _transonicRange = Round(403 call FUNC(calculate_distance_at_velocity));
     };