Added comments to all functions

This commit is contained in:
ulteq 2015-04-07 17:58:54 +02:00
parent 7d42eeed28
commit b62827c050
6 changed files with 85 additions and 0 deletions

View File

@ -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" #include "script_component.hpp"
switch (_this) do { switch (_this) do {

View File

@ -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 "script_component.hpp"
#include "defines.h" #include "defines.h"

View File

@ -1,3 +1,17 @@
/*
* Author: Ruthberg
* Opens the Kestrel 4500 dialog
*
* Arguments:
* Nothing
*
* Return Value:
* Nothing
*
* Example:
*
* Public: No
*/
#include "script_component.hpp" #include "script_component.hpp"
if (dialog) exitWith { false }; if (dialog) exitWith { false };

View File

@ -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" #include "script_component.hpp"
#define __dsp (uiNamespace getVariable "RscKestrel4500") #define __dsp (uiNamespace getVariable "RscKestrel4500")

View File

@ -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 "script_component.hpp"
#include "defines.h" #include "defines.h"

View File

@ -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" #include "script_component.hpp"
private ["_outputData"]; private ["_outputData"];