From be356e4ef3a11909db98e92ad3f269b80965e155 Mon Sep 17 00:00:00 2001
From: Valmo Trindade <val_mo_jr@hotmail.com>
Date: Sun, 26 Jan 2025 13:09:50 -0300
Subject: [PATCH] added description to sqf functions

---
 addons/main/functions/extract_data/fn_extract_callsign.sqf   | 4 ++++
 addons/main/functions/extract_data/fn_extract_drone_info.sqf | 4 ++++
 addons/main/functions/extract_data/fn_extract_human_role.sqf | 1 +
 addons/main/functions/extract_data/fn_extract_role.sqf       | 5 +++++
 addons/main/functions/extract_data/fn_extract_side.sqf       | 5 +++++
 addons/main/functions/extract_data/fn_extract_uuid.sqf       | 4 ++++
 .../functions/extract_data/fn_ots_extract_auth_token.sqf     | 4 ++++
 7 files changed, 27 insertions(+)
 create mode 100644 addons/main/functions/extract_data/fn_extract_human_role.sqf

diff --git a/addons/main/functions/extract_data/fn_extract_callsign.sqf b/addons/main/functions/extract_data/fn_extract_callsign.sqf
index 8c7c462..76d9ac6 100644
--- a/addons/main/functions/extract_data/fn_extract_callsign.sqf
+++ b/addons/main/functions/extract_data/fn_extract_callsign.sqf
@@ -1,3 +1,7 @@
+// function name: armatak_fnc_extract_callsign
+// function author: Valmo
+// function description: Gets the unit name or classname to be used as TAK callsign
+
 params["_unit"];
 private _callsign = "";
 if (roleDescription _unit != "") then {
diff --git a/addons/main/functions/extract_data/fn_extract_drone_info.sqf b/addons/main/functions/extract_data/fn_extract_drone_info.sqf
index 623b03d..b75892f 100644
--- a/addons/main/functions/extract_data/fn_extract_drone_info.sqf
+++ b/addons/main/functions/extract_data/fn_extract_drone_info.sqf
@@ -1,3 +1,7 @@
+// function name: armatak_fnc_extract_drone
+// function author: Valmo
+// function description: Gets the drone information for the HTTP request
+
 params["_drone"];
 
 private _location = (getPos _drone) call armatak_fnc_convert_location;
diff --git a/addons/main/functions/extract_data/fn_extract_human_role.sqf b/addons/main/functions/extract_data/fn_extract_human_role.sqf
new file mode 100644
index 0000000..6e8f797
--- /dev/null
+++ b/addons/main/functions/extract_data/fn_extract_human_role.sqf
@@ -0,0 +1 @@
+params["_unit"];
diff --git a/addons/main/functions/extract_data/fn_extract_role.sqf b/addons/main/functions/extract_data/fn_extract_role.sqf
index d1d4004..9e0a9ef 100644
--- a/addons/main/functions/extract_data/fn_extract_role.sqf
+++ b/addons/main/functions/extract_data/fn_extract_role.sqf
@@ -1,4 +1,9 @@
+// function name: armatak_fnc_extract_role
+// function author: Valmo
+// function description: Gets the unit function to be used as TAK role or NATO 2525 marker
+
 params["_unit"];
+
 private _affiliation = "f";
 private _type = "G";
 private _role = "a-f-G-U-C-I";
diff --git a/addons/main/functions/extract_data/fn_extract_side.sqf b/addons/main/functions/extract_data/fn_extract_side.sqf
index 0c86d12..671b570 100644
--- a/addons/main/functions/extract_data/fn_extract_side.sqf
+++ b/addons/main/functions/extract_data/fn_extract_side.sqf
@@ -1,4 +1,9 @@
+// function name: armatak_fnc_extract_side
+// function author: Valmo
+// function description: Gets the unit side
+
 params["_unit"];
+
 _side = "friendly";
 switch (side _unit) do {
 	case "WEST": {
diff --git a/addons/main/functions/extract_data/fn_extract_uuid.sqf b/addons/main/functions/extract_data/fn_extract_uuid.sqf
index d1d4a50..5470fdb 100644
--- a/addons/main/functions/extract_data/fn_extract_uuid.sqf
+++ b/addons/main/functions/extract_data/fn_extract_uuid.sqf
@@ -1,3 +1,7 @@
+// function name: armatak_fnc_extract_uuid
+// function author: Valmo
+// function description: Defines a random v4 uuid if the doesn't have one already
+
 params["_unit"];
 
 _uuid = _unit getVariable "_atak_uid";
diff --git a/addons/main/functions/extract_data/fn_ots_extract_auth_token.sqf b/addons/main/functions/extract_data/fn_ots_extract_auth_token.sqf
index 82a7723..ea1d72e 100644
--- a/addons/main/functions/extract_data/fn_ots_extract_auth_token.sqf
+++ b/addons/main/functions/extract_data/fn_ots_extract_auth_token.sqf
@@ -1,3 +1,7 @@
+// function name: armatak_fnc_extract_auth_token
+// function author: Valmo
+// function description: Gets the mission params and authenticate on OpenTAKServer API to be able to send HTTP requests
+
 private _atak_server_instance = missionNamespace getVariable "_atak_server_instance";
 private _atak_server_instance_username = missionNamespace getVariable "_atak_server_instance_username";
 private _atak_server_instance_password = missionNamespace getVariable "_atak_server_instance_password";