Update headers

addons/medical/functions/fnc_setUnconscious.sqf

@@ -19,7 +19,6 @@
  *
  * Public: yes
  */
-// #define DEBUG_MODE_FULL
 
 // only run this after the settings are initialized
 if !(EGVAR(common,settingsInitFinished)) exitWith {

addons/medical_blood/functions/fnc_handleWoundReceived.sqf

@@ -5,12 +5,16 @@
  *
  * Arguments:
  * 0: unit <OBJECT>
- * 1: caused by <OBJECT>
+ * 1: bodyPart <String>
  * 2: damage <NUMBER>
+ * 3: shooter <OBJECT>
  *
  * Return Value:
  * None
  *
+ * Example:
+ * [player, "Body", 0.5, badGuy] call ace_medical_blood_fnc_handleWoundReceived
+ *
  * Public: No
  */
 

addons/medical_blood/functions/fnc_isBleeding.sqf

@@ -10,7 +10,7 @@
  * is Bleeding <BOOL>
  *
  * Example:
- * [UNIT] call ace_medical_blood_fnc_isBleeding
+ * [player] call ace_medical_blood_fnc_isBleeding
  *
  * Public: No
  */

addons/medical_blood/functions/fnc_onBleeding.sqf

@@ -10,7 +10,7 @@
  * is Bleeding <BOOL>
  *
  * Example:
- * [UNIT] call ace_medical_blood_fnc_onBleeding
+ * [player] call ace_medical_blood_fnc_onBleeding
  *
  * Public: No
  */

addons/medical_damage/functions/fnc_getTypeOfDamage.sqf

@@ -10,7 +10,7 @@
  * Type of damage <STRING>
  *
  * Example:
- * ["bullet"] call ACE_medical_fnc_getTypeOfDamage
+ * ["bullet"] call ace_medical_damage_fnc_getTypeOfDamage
  *
  * Public: No
  */

addons/medical_damage/functions/fnc_handleIncapacitation.sqf

@@ -7,7 +7,10 @@
  * 0: The Unit <OBJECT>
  *
  * ReturnValue:
- * nothing
+ * None
+ *
+ * Example:
+ * [player] call ace_medical_damage_fnc_handleIncapacitation
  *
  * Public: No
  */

addons/medical_damage/functions/fnc_parseConfigForInjuries.sqf

@@ -9,6 +9,9 @@
  * ReturnValue:
  * None
  *
+ * Example:
+ * [] call ace_medical_damage_fnc_parseConfigForInjuries
+ *
  * Public: No
  */
 

addons/medical_damage/functions/fnc_woundsHandler.sqf

@@ -12,6 +12,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player, "Body", 0.5, "bullet"] call ace_medical_damage_fnc_woundsHandler
+ *
  * Public: No
  */
 

addons/medical_damage/functions/fnc_woundsHandlerSQF.sqf

@@ -12,11 +12,14 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player, "Body", 0.5, "bullet"] call ace_medical_damage_fnc_woundsHandlerSQF
+ *
  * Public: No
  */
 
 params ["_unit", "_bodyPart", "_damage", "_typeOfDamage"];
-TRACE_5("start",_unit,_bodyPart,_damage,_typeOfDamage);
+TRACE_4("start",_unit,_bodyPart,_damage,_typeOfDamage);
 
 // Convert the selectionName to a number and ensure it is a valid selection.
 private _bodyPartN = ALL_BODY_PARTS find toLower _bodyPart;

addons/medical_engine/functions/fnc_setUnconsciousAnim.sqf

@@ -11,7 +11,7 @@
  * None
  *
  * Example:
- * player call ace_medical_engine_fnc_setUnconsciousAnim
+ * [player, true] call ace_medical_engine_fnc_setUnconsciousAnim
  *
  * Public: No
  */

addons/medical_feedback/functions/fnc_effectBleeding.sqf

@@ -9,6 +9,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [false, 0.5] call ace_medical_feedback_fnc_effectBleeding
+ *
+ * Public: No
  */
 
 params ["_enable", "_bloodloss"];

addons/medical_feedback/functions/fnc_effectBloodVolume.sqf

@@ -9,6 +9,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [false, 0.5] call ace_medical_feedback_fnc_effectBloodVolume
+ *
+ * Public: No
  */
 
 params ["_enable", "_intensity"];

addons/medical_feedback/functions/fnc_effectHeartBeat.sqf

@@ -8,6 +8,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [120] call ace_medical_feedback_fnc_effectHeartBeat
+ *
+ * Public: No
  */
 
 params ["_heartRate"];

addons/medical_feedback/functions/fnc_effectIncapacitated.sqf

@@ -8,6 +8,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [] call ace_medical_feedback_fnc_effectIncapacitated
+ *
+ * Public: No
  */
 
 GVAR(ppIncapacitationBlur)  ppEffectEnable true;

addons/medical_feedback/functions/fnc_effectPain.sqf

@@ -9,6 +9,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [true, 0.5] call ace_medical_feedback_fnc_effectPain
+ *
+ * Public: No
  */
 
 params ["_enable", "_intensity"];

addons/medical_feedback/functions/fnc_effectUnconscious.sqf

@@ -9,6 +9,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [true, 0] call ace_medical_feedback_fnc_effectUnconscious
+ *
+ * Public: No
  */
 
 params ["_enable", "_mode"];

addons/medical_feedback/functions/fnc_handleEffects.sqf

@@ -9,6 +9,11 @@
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [] call ace_medical_feedback_fnc_handleEffects
+ *
+ * Public: No
  */
 
 if (EGVAR(common,OldIsCamera) || {!alive ACE_player}) exitWith {

addons/medical_feedback/functions/fnc_initEffects.sqf

@@ -4,10 +4,15 @@
  * Initializes visual effects of medical.
  *
  * Arguments:
- * None
+ * 0: Just Pain Effects <BOOL>
  *
  * Return Value:
  * None
+ *
+ * Example:
+ * [false] call ace_medical_feedback_fnc_initEffects
+ *
+ * Public: No
  */
 
 params [["_justPain", false]];

addons/medical_gui/functions/fnc_bloodLossToRGBA.sqf

@@ -12,7 +12,7 @@
  * Representative RGBA colour <ARRAY>
  *
  * Example:
- * [0.4] call ACE_medical_gui_fnc_bloodLossToRGBA
+ * [0.4] call ace_medical_gui_fnc_bloodLossToRGBA
  *
  * Public: No
  */

addons/medical_gui/functions/fnc_damageToRGBA.sqf

@@ -12,7 +12,7 @@
  * Representative RGBA colour <ARRAY>
  *
  * Example:
- * [0.4] call ACE_medical_gui_fnc_damageToRGBA
+ * [0.4] call ace_medical_gui_fnc_damageToRGBA
  *
  * Public: No
  */

addons/medical_statemachine/functions/fnc_conditionCardiacArrestTimer.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_conditionCardiacArrestTimer
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_conditionExecutionDeath.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_conditionExecutionDeath
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_enteredStateCardiacArrest.sqf

@@ -10,6 +10,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_enteredStateCardiacArrest
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_enteredStateDeath.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_enteredStateDeath
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_enteredStateFatalInjury.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_enteredStateFatalInjury
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_handleStateDefault.sqf

@@ -1,7 +1,7 @@
 #include "script_component.hpp"
 /*
  * Author: BaerMitUmlaut
- *
+ * Handles the default state
  *
  * Arguments:
  * 0: The Unit <OBJECT>
@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_handleStateDefault
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_handleStateInjured.sqf

@@ -1,7 +1,7 @@
 #include "script_component.hpp"
 /*
  * Author: BaerMitUmlaut
- *
+ * Handles the injured state
  *
  * Arguments:
  * 0: The Unit <OBJECT>
@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_handleStateInjured
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_handleStateUnconscious.sqf

@@ -1,7 +1,7 @@
 #include "script_component.hpp"
 /*
  * Author: BaerMitUmlaut
- *
+ * Handles the unconscious state
  *
  * Arguments:
  * 0: The Unit <OBJECT>
@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_handleStateUnconscious
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_leftStateCardiacArrest.sqf

@@ -10,6 +10,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_leftStateCardiacArrest
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_resetStateDefault.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_resetStateDefault
+ *
  * Public: No
  */
 

addons/medical_statemachine/functions/fnc_transitionSecondChance.sqf

@@ -9,6 +9,9 @@
  * Return Value:
  * None
  *
+ * Example:
+ * [player] call ace_medical_statemachine_fnc_transitionSecondChance
+ *
  * Public: No
  */
 

addons/medical_status/functions/fnc_adjustPainLevel.sqf

@@ -8,7 +8,7 @@
  * 1: Desired pain level (0 .. 1) <NUMBER>
  *
  * Return Value:
- * nothing
+ * None
  *
  * Example:
  * [guy, 0.5] call ace_medical_status_fnc_adjustPainLevel

addons/medical_status/functions/fnc_getBloodLoss.sqf

@@ -10,7 +10,7 @@
  * Total blood loss of unit <NUMBER>
  *
  * Example:
- * [bob] call ACE_medical_fnc_getBloodLoss
+ * [bob] call ace_medical_status_fnc_getBloodLoss
  *
  * Public: No
  */

addons/medical_status/functions/fnc_getBloodPressure.sqf

@@ -11,7 +11,7 @@
  * 1: BloodPressure High <NUMBER>
  *
  * Example:
- * [player] call ace_medical_fnc_getBloodPressure
+ * [player] call ace_medical_status_fnc_getBloodPressure
  *
  * Public: No
  */

addons/medical_status/functions/fnc_getBloodVolumeChange.sqf

@@ -12,7 +12,7 @@
  * Blood volume change (liters per second) <NUMBER>
  *
  * Example:
- * [player, 1, true] call ACE_medical_status_fnc_getBloodVolumeChange
+ * [player, 1, true] call ace_medical_status_fnc_getBloodVolumeChange
  *
  * Public: No
  */

addons/medical_status/functions/fnc_initUnit.sqf

@@ -10,7 +10,7 @@
  * None
  *
  * Example:
- * [bob] call ACE_medical_fnc_init
+ * [bob] call ace_medical_status_fnc_init
  *
  * Public: No
  */

addons/medical_status/functions/fnc_isInStableCondition.sqf

@@ -10,7 +10,7 @@
  * Is in stable condition <BOOL>
  *
  * Example:
- * [player] call ace_medical_fnc_isInStableCondition
+ * [player] call ace_medical_status_fnc_isInStableCondition
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_actionCheckResponse.sqf

@@ -11,7 +11,7 @@
  * None
  *
  * Example:
- * [bob, kevin] call ACE_medical_treatment_fnc_actionCheckResponse
+ * [bob, kevin] call ace_medical_treatment_fnc_actionCheckResponse
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_actionLoadUnit.sqf

@@ -12,7 +12,7 @@
  * Vehicle they are loaded into (objNull on failure) <OBJECT>
  *
  * Example:
- * [bob, kevin] call ACE_medical_treatment_treatment_fnc_actionLoadUnit
+ * [bob, kevin] call ace_medical_treatment_treatment_fnc_actionLoadUnit
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_actionPlaceInBodyBag.sqf

@@ -11,9 +11,9 @@
  * body bag (will return objNull when run where target is not local) <OBJECT>
  *
  * Example:
- * [player, cursorTarget] call ACE_medical_treatment_fnc_actionPlaceInBodyBag
+ * [player, cursorTarget] call ace_medical_treatment_fnc_actionPlaceInBodyBag
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target"];

addons/medical_treatment/functions/fnc_actionUnloadUnit.sqf

@@ -12,7 +12,7 @@
  * None
  *
  * Example:
- * [bob, kevin, false] call ACE_medical_treatment_fnc_actionUnloadUnit
+ * [bob, kevin, false] call ace_medical_treatment_fnc_actionUnloadUnit
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_addToLog.sqf

@@ -13,9 +13,9 @@
  * None
  *
  * Example:
- * [bob, "type", "message", [_args]] call ACE_medical_treatment_fnc_addToLog
+ * [bob, "type", "message", [_args]] call ace_medical_treatment_fnc_addToLog
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_unit", "_type", "_message", "_arguments"];

addons/medical_treatment/functions/fnc_addToTriageCard.sqf

@@ -11,9 +11,9 @@
  * None
  *
  * Example:
- * [bob, "bandage"] call ACE_medical_treatment_fnc_addToTriageCard
+ * [bob, "bandage"] call ace_medical_treatment_fnc_addToTriageCard
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_unit", "_newItem"];

addons/medical_treatment/functions/fnc_bodyCleanupLoop.sqf

@@ -10,7 +10,7 @@
  * None
  *
  * Example:
- * call ACE_medical_treatment_fnc_bodyCleanupLoop
+ * call ace_medical_treatment_fnc_bodyCleanupLoop
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_canAccessMedicalEquipment.sqf

@@ -11,9 +11,9 @@
  * Can Treat <BOOL>
  *
  * Example:
- * [bob, target] call ACE_medical_treatment_fnc_canAccessMedicalEquipment
+ * [bob, target] call ace_medical_treatment_fnc_canAccessMedicalEquipment
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target"];

addons/medical_treatment/functions/fnc_canTreat.sqf

@@ -15,7 +15,7 @@
  * Example:
  * [player, cursorTarget, "Head", "SurgicalKit"] call ace_medical_treatment_fnc_canTreat
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target", "_bodyPart", "_className"];

addons/medical_treatment/functions/fnc_canTreatCached.sqf

@@ -13,7 +13,7 @@
  * Can Treat <BOOL>
  *
  * Example:
- * [bob, kevin, "selection", "classname"] call ACE_medical_treatment_fnc_canTreatCached
+ * [bob, kevin, "selection", "classname"] call ace_medical_treatment_fnc_canTreatCached
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_dropDownTriageCard.sqf

@@ -10,9 +10,9 @@
  * None
  *
  * Example:
- * [true] call ACE_medical_treatment_fnc_dropDownTriageCard
+ * [true] call ace_medical_treatment_fnc_dropDownTriageCard
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_show"];

addons/medical_treatment/functions/fnc_getTriageStatus.sqf

@@ -16,7 +16,7 @@
  * Example:
  * [player] call ace_medical_treatment_fnc_getTriageStatus
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_unit"];

addons/medical_treatment/functions/fnc_hasItem.sqf

@@ -12,9 +12,9 @@
  * Has the items <BOOL>
  *
  * Example:
- * [bob, patient, "bandage"] call ACE_medical_treatment_fnc_hasItem
+ * [bob, patient, "bandage"] call ace_medical_treatment_fnc_hasItem
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_medic", "_patient", "_item"];

addons/medical_treatment/functions/fnc_hasItems.sqf

@@ -12,9 +12,9 @@
  * Has the items <BOOL>
  *
  * Example:
- * [bob, patient, ["bandage", "morphine"]] call ACE_medical_treatment_fnc_hasItems
+ * [bob, patient, ["bandage", "morphine"]] call ace_medical_treatment_fnc_hasItems
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_medic", "_patient", "_items"];

addons/medical_treatment/functions/fnc_isMedicalVehicle.sqf

@@ -12,7 +12,7 @@
  * Example:
  * [cursorObject] call ace_medical_treatment_fnc_isMedicalVehicle
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_vehicle"];

addons/medical_treatment/functions/fnc_litterCleanupLoop.sqf

@@ -10,7 +10,7 @@
  * None
  *
  * Example:
- * call ACE_medical_treatment_fnc_litterCleanupLoop
+ * call ace_medical_treatment_fnc_litterCleanupLoop
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_litterHandleCreate.sqf

@@ -12,7 +12,7 @@
  * None
  *
  * Example:
- * ["litter", [2, 5, 6], bob] call ACE_medical_treatment_fnc_handleCreateLitter
+ * ["litter", [2, 5, 6], bob] call ace_medical_treatment_fnc_handleCreateLitter
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_onMedicationUsage.sqf

@@ -14,7 +14,7 @@
  * None
  *
  * Example:
- * [bob, "classname", "varname", 5, 6, ["stuff"]] call ACE_medical_treatment_fnc_onMedicationUsage
+ * [bob, "classname", "varname", 5, 6, ["stuff"]] call ace_medical_treatment_fnc_onMedicationUsage
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_treatmentCPR.sqf

@@ -12,7 +12,7 @@
  * Return Value:
  * Succesful treatment started <BOOL>
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target", "_selectionName", "_className", "_items"];

addons/medical_treatment/functions/fnc_treatmentCPRLocal.sqf

@@ -10,7 +10,7 @@
  * Return Value:
  * Succesful treatment started <BOOL>
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target"];

addons/medical_treatment/functions/fnc_treatmentFullHeal.sqf

@@ -13,7 +13,7 @@
  * Return Value:
  * Succesful treatment started <BOOL>
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target"];

addons/medical_treatment/functions/fnc_treatmentIV.sqf

@@ -13,7 +13,7 @@
  * Return Value:
  * Succesful treatment started <BOOL>
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target", "_bodyPart", "_className", "_items"];

addons/medical_treatment/functions/fnc_treatmentIVLocal.sqf

@@ -11,7 +11,7 @@
  * Return Value:
  * None
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_target", "_treatmentClassname", "_bodyPart"];

addons/medical_treatment/functions/fnc_treatmentMedication.sqf

@@ -13,7 +13,7 @@
  * Return Value:
  * Succesful treatment started <BOOL>
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target", "_bodyPart", "_className", "_items"];

addons/medical_treatment/functions/fnc_treatmentMedicationLocal.sqf

@@ -11,7 +11,7 @@
  * Return Value:
  * Succesful treatment started <BOOL>
  *
- * Public: Yes
+ * Public: No
  */
 #define MORPHINE_PAIN_SUPPRESSION 0.6
 

addons/medical_treatment/functions/fnc_treatmentSurgicalKit_onProgress.sqf

@@ -14,7 +14,7 @@
  * Succesful treatment started <BOOL>
  *
  * Example:
- * [[bob, kevin], 5, 5] call ACE_medical_treatment_fnc_treatmentAdvanced_surgicalKit_onProgress
+ * [[bob, kevin], 5, 5] call ace_medical_treatment_fnc_treatmentAdvanced_surgicalKit_onProgress
  *
  * Public: No
  */

addons/medical_treatment/functions/fnc_treatmentTourniquetRemove.sqf

@@ -11,7 +11,7 @@
  * Return Value:
  * None
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_caller", "_target", "_bodyPart"];

addons/medical_treatment/functions/fnc_useItem.sqf

@@ -12,7 +12,7 @@
  * 0: success <BOOL>
  * 1: Unit <OBJECT>
  *
- * Public: Yes
+ * Public: No
  */
 
 params ["_medic", "_patient", "_item"];

addons/medical_treatment/functions/fnc_useItems.sqf

@@ -13,9 +13,9 @@
  * 1: Unit <OBJECT>
  *
  * Example:
- * [unit, patient, ["bandage"]] call ACE_medical_treatment_fnc_useItems
+ * [unit, patient, ["bandage"]] call ace_medical_treatment_fnc_useItems
  *
- * Public: Yes
+ * Public: No
  */
 
 #define HAS_USED_ITEM(itemUsedInfo)    (itemUsedInfo select 0)