From 80778cf8dbd087cad269ff8e588dd201f8a6ba95 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicol=C3=A1s=20Badano?= <nicolas.d.badano@gmail.com>
Date: Sun, 8 Feb 2015 19:54:12 -0300
Subject: [PATCH] overheating: updated headers

---
 .../functions/fnc_checkTemperature.sqf           | 11 +++++++----
 addons/overheating/functions/fnc_clearJam.sqf    | 15 ++++++++-------
 addons/overheating/functions/fnc_cooldown.sqf    | 11 ++++++-----
 .../functions/fnc_displayTemperature.sqf         |  6 +++---
 addons/overheating/functions/fnc_jamWeapon.sqf   |  7 ++++---
 addons/overheating/functions/fnc_overheat.sqf    | 16 +++++++++-------
 addons/overheating/functions/fnc_swapBarrel.sqf  |  7 ++++---
 .../functions/fnc_swapBarrelCallback.sqf         |  7 ++++---
 8 files changed, 45 insertions(+), 35 deletions(-)

diff --git a/addons/overheating/functions/fnc_checkTemperature.sqf b/addons/overheating/functions/fnc_checkTemperature.sqf
index 92b6d1727e..02747b0129 100644
--- a/addons/overheating/functions/fnc_checkTemperature.sqf
+++ b/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 Values:
+ * Return Value:
  * None
  *
+ * Example:
+ * None
+ *
+ * Public: No
  */
 #include "\z\ace\addons\overheating\script_component.hpp"
 
diff --git a/addons/overheating/functions/fnc_clearJam.sqf b/addons/overheating/functions/fnc_clearJam.sqf
index 2340c6c890..76941d75ac 100644
--- a/addons/overheating/functions/fnc_clearJam.sqf
+++ b/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"
 
diff --git a/addons/overheating/functions/fnc_cooldown.sqf b/addons/overheating/functions/fnc_cooldown.sqf
index 13d53c7327..718c77474f 100644
--- a/addons/overheating/functions/fnc_cooldown.sqf
+++ b/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"
 
diff --git a/addons/overheating/functions/fnc_displayTemperature.sqf b/addons/overheating/functions/fnc_displayTemperature.sqf
index 130eec5f39..9af817f8fd 100644
--- a/addons/overheating/functions/fnc_displayTemperature.sqf
+++ b/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"
 
diff --git a/addons/overheating/functions/fnc_jamWeapon.sqf b/addons/overheating/functions/fnc_jamWeapon.sqf
index beb3a1925b..f11b72688c 100644
--- a/addons/overheating/functions/fnc_jamWeapon.sqf
+++ b/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"
 
diff --git a/addons/overheating/functions/fnc_overheat.sqf b/addons/overheating/functions/fnc_overheat.sqf
index 05a286cfa2..9f26d51869 100644
--- a/addons/overheating/functions/fnc_overheat.sqf
+++ b/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"
 
diff --git a/addons/overheating/functions/fnc_swapBarrel.sqf b/addons/overheating/functions/fnc_swapBarrel.sqf
index 6bacbe5049..2384fb470e 100644
--- a/addons/overheating/functions/fnc_swapBarrel.sqf
+++ b/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"
 
diff --git a/addons/overheating/functions/fnc_swapBarrelCallback.sqf b/addons/overheating/functions/fnc_swapBarrelCallback.sqf
index 88201dc9f4..e626bf2aea 100644
--- a/addons/overheating/functions/fnc_swapBarrelCallback.sqf
+++ b/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"