From b62827c050e368e1945d9ca71bf7adf8438a68da Mon Sep 17 00:00:00 2001
From: ulteq <ulteq@web.de>
Date: Tue, 7 Apr 2015 17:58:54 +0200
Subject: [PATCH] Added comments to all functions

---
 .../kestrel4500/functions/fnc_buttonPressed.sqf   | 15 +++++++++++++++
 addons/kestrel4500/functions/fnc_collectData.sqf  | 14 ++++++++++++++
 .../functions/fnc_createKestrelDialog.sqf         | 14 ++++++++++++++
 .../kestrel4500/functions/fnc_displayKestrel.sqf  | 14 ++++++++++++++
 .../functions/fnc_generateOutputData.sqf          | 14 ++++++++++++++
 .../kestrel4500/functions/fnc_updateDisplay.sqf   | 14 ++++++++++++++
 6 files changed, 85 insertions(+)

diff --git a/addons/kestrel4500/functions/fnc_buttonPressed.sqf b/addons/kestrel4500/functions/fnc_buttonPressed.sqf
index 776c836abb..4db32ab40d 100644
--- a/addons/kestrel4500/functions/fnc_buttonPressed.sqf
+++ b/addons/kestrel4500/functions/fnc_buttonPressed.sqf
@@ -1,3 +1,18 @@
+/*
+ * Author: Ruthberg
+ * Handles the Kestrel 4500 dialog button actions
+ *
+ * Arguments:
+ * buttonID <integer>
+ *
+ * Return Value:
+ * Nothing
+ *
+ * Example:
+ * 2 call ace_kestrel4500_fnc_buttonPressed
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 
 switch (_this) do {
diff --git a/addons/kestrel4500/functions/fnc_collectData.sqf b/addons/kestrel4500/functions/fnc_collectData.sqf
index cc0debb6c9..ca1a694184 100644
--- a/addons/kestrel4500/functions/fnc_collectData.sqf
+++ b/addons/kestrel4500/functions/fnc_collectData.sqf
@@ -1,3 +1,17 @@
+/*
+ * Author: Ruthberg
+ * Gathers the weather data for the Kestrel 4500
+ *
+ * Arguments:
+ * Nothing
+ *
+ * Return Value:
+ * Nothing
+ *
+ * Example:
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 #include "defines.h"
 
diff --git a/addons/kestrel4500/functions/fnc_createKestrelDialog.sqf b/addons/kestrel4500/functions/fnc_createKestrelDialog.sqf
index 6439566b16..77243a2f11 100644
--- a/addons/kestrel4500/functions/fnc_createKestrelDialog.sqf
+++ b/addons/kestrel4500/functions/fnc_createKestrelDialog.sqf
@@ -1,3 +1,17 @@
+/*
+ * Author: Ruthberg
+ * Opens the Kestrel 4500 dialog
+ *
+ * Arguments:
+ * Nothing
+ *
+ * Return Value:
+ * Nothing
+ *
+ * Example:
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 
 if (dialog) exitWith { false };
diff --git a/addons/kestrel4500/functions/fnc_displayKestrel.sqf b/addons/kestrel4500/functions/fnc_displayKestrel.sqf
index cd9d7f02a4..da99256456 100644
--- a/addons/kestrel4500/functions/fnc_displayKestrel.sqf
+++ b/addons/kestrel4500/functions/fnc_displayKestrel.sqf
@@ -1,3 +1,17 @@
+/*
+ * Author: Ruthberg
+ * Shows the Kestrel 4500 as rsc title
+ *
+ * Arguments:
+ * Nothing
+ *
+ * Return Value:
+ * Nothing
+ *
+ * Example:
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 
 #define __dsp (uiNamespace getVariable "RscKestrel4500")
diff --git a/addons/kestrel4500/functions/fnc_generateOutputData.sqf b/addons/kestrel4500/functions/fnc_generateOutputData.sqf
index 451f1c5282..f0cfa43a90 100644
--- a/addons/kestrel4500/functions/fnc_generateOutputData.sqf
+++ b/addons/kestrel4500/functions/fnc_generateOutputData.sqf
@@ -1,3 +1,17 @@
+/*
+ * Author: Ruthberg
+ * Generates the Kestrel 4500 output text.
+ *
+ * Arguments:
+ * Nothing
+ *
+ * Return Value:
+ * [top <STRING>, centerBig <STRING>, CenterLine1Left <STRING>, CenterLine2Left <STRING>, CenterLine3Left <STRING>, CenterLine1Right <STRING>, CenterLine2Right <STRING>, CenterLine3Right <STRING>, InfoLine1 <STRING>, InfoLine2 <STRING>]
+ *
+ * Example:
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 #include "defines.h"
 
diff --git a/addons/kestrel4500/functions/fnc_updateDisplay.sqf b/addons/kestrel4500/functions/fnc_updateDisplay.sqf
index a28a7071d6..58f2c6d683 100644
--- a/addons/kestrel4500/functions/fnc_updateDisplay.sqf
+++ b/addons/kestrel4500/functions/fnc_updateDisplay.sqf
@@ -1,3 +1,17 @@
+/*
+ * Author: Ruthberg
+ * Updates the Kestrel 4500 dialog text boxes.
+ *
+ * Arguments:
+ * Nothing
+ *
+ * Return Value:
+ * Nothing
+ *
+ * Example:
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 
 private ["_outputData"];