overheating: updated headers

addons/overheating/functions/fnc_checkTemperature.sqf

@@ -1,15 +1,18 @@
 /*
  * Author: Commy2 and CAA-Picard
- *
  * Make the player check the temperature of his weapon
  *
  * Arguments:
- * 0: _player
- * 1: _weapon
+ * 0: Player <OBJECT>
+ * 1: Weapon <STRING>
+ *
+ * Return Value:
+ * None
  *
- * Return Values:
+ * Example:
  * None
  *
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"
 

addons/overheating/functions/fnc_clearJam.sqf

@@ -1,15 +1,16 @@
 /*
  * Author: Commy2
+ * Make the unit clear the jam from a weapon
  *
- * Clears the jam from a weapon
+ * Arguments:
+ * 0: Player <OBJECT>
+ * 1: Weapon <STRING>
+ * 2: Skip anim? <BOOL>
  *
- * Argument:
- * 0: Last temperature (number)
- * 1: Barrel mass (number)
- * 2: Time (number)
+ * Return Value:
+ * None
  *
- * Return value:
- * New temperature (number)
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"
 

addons/overheating/functions/fnc_cooldown.sqf

@@ -1,15 +1,16 @@
 /*
  * Author: CAA-Picard
- *
  * Calculate cooling down of the weapon.
  *
  * Argument:
- * 0: Last temperature (number)
- * 1: Barrel mass (number)
- * 2: Time (number)
+ * 0: Last temperature <NUMBER>
+ * 1: Barrel mass <NUMBER>
+ * 2: Time <NUMBER>
  *
  * Return value:
- * New temperature (number)
+ * New temperature <NUMBER>
+ *
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"
 

addons/overheating/functions/fnc_displayTemperature.sqf

@@ -1,15 +1,15 @@
 /*
  * Author: Commy2 and CAA-Picard
- *
  * Displays the weapon temperature
  *
  * Arguments:
- * 0: _player
- * 1: _weapon
+ * 0: Player <OBJECT>
+ * 1: Weapon <STRING>
  *
  * Return Values:
  * None
  *
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"
 

addons/overheating/functions/fnc_jamWeapon.sqf

@@ -1,14 +1,15 @@
 /*
  * Author: Commy2, based on KK_fnc_playerWeaponMulfunction from KillzoneKid
- *
  * Jam the weapon
  *
  * Argument:
- * 0: unit
- * 1: weapon
+ * 0: Unit <OBJECT>
+ * 1: Weapon <STRING>
  *
  * Return value:
  * None
+ *
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"
 

addons/overheating/functions/fnc_overheat.sqf

@@ -1,17 +1,19 @@
 /*
  * Author: Commy2 and CAA-Picard
- *
- * Heat up the weapon
+ * Handle weapon fire, heat up the weapon
  *
  * Argument:
- * 0: unit
- * 1: weapon
- * 2: ammo
- * 3: projectile
- * 4: velocity
+ * 0: Unit <OBJECT>
+ * 1: Weapon <STRING>
+ * 3: Muzzle <STRING>
+ * 4: Ammo <STRING>
+ * 5: Magazine <STRING>
+ * 6: Projectile <OBJECT>
  *
  * Return value:
  * None
+ *
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"
 

addons/overheating/functions/fnc_swapBarrel.sqf

@@ -1,14 +1,15 @@
 /*
  * Author: Commy2
- *
  * Make a unit start swapping it's barrel
  *
  * Argument:
- * 0: unit
- * 1: weapon
+ * 0: Unit <OBJECT>
+ * 1: Weapon <STRING>
  *
  * Return value:
  * None
+ *
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"
 

addons/overheating/functions/fnc_swapBarrelCallback.sqf

@@ -1,14 +1,15 @@
 /*
  * Author: Commy2
- *
  * Swap barrel callback
  *
  * Argument:
- * 0: unit
- * 1: weapon
+ * 0: Unit <OBJECT>
+ * 1: Weapon <STRING>
  *
  * Return value:
  * None
+ *
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"