Update script headers

ConnorAU · Nov 18, 2020 · ebb783a · ebb783a
1 parent 946e96a
commit ebb783a
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 33 deletions.
diff --git a/addon/pbo/fn_buildCfg.sqf b/addon/pbo/fn_buildCfg.sqf
@@ -1,10 +1,22 @@
-/*──────────────────────────────────────────────────────┐
-│   Author: Connor                                      │
-│   Steam:  https://steamcommunity.com/id/_connor       │
-│   Github: https://github.com/ConnorAU                 │
-│                                                       │
-│   Please do not modify or remove this comment block   │
-└──────────────────────────────────────────────────────*/
+/* ----------------------------------------------------------------------------
+Project:
+	https://github.com/ConnorAU/SQFDiscordEmbedBuilder
+
+Author:
+	ConnorAU - https://github.com/ConnorAU
+
+Function:
+	DiscordEmbedBuilder_fnc_buildCfg
+
+Description:
+	Builds a message from the config template provided
+
+Information:
+	https://github.com/ConnorAU/SQFDiscordEmbedBuilder/wiki/Build-with-config-templates
+
+Return:
+	BOOL - true if the message was sent to the extension
+---------------------------------------------------------------------------- */
 
 // The extension deserializer doesn't like empty strings, so this string is reserved as empty
 #define EMPTY_STRING toString[1]
@@ -16,7 +28,7 @@ private _cfgDir = configFile >> "CfgDiscordEmbedBuilder" >> _template;
 if (isNull _cfgDir) exitwith {false};
 
 private _emptyString = { [EMPTY_STRING,_this] select (_this != ""); };
-private _formatString = { 
+private _formatString = {
 	params [["_str","",[""]],["_replaceEmpty",true,[true]]];
 	private _str = format([_str]+_textParameters);
 	if _replaceEmpty then {_str call _emptyString} else {_str}
@@ -38,7 +50,7 @@ private ["_title","_description","_url","_color","_timestamp","_thumbnail","_ima
 	_timestamp = getNumber(_x >> "timestamp");
 	_thumbnail = getText(_x >> "thumbnail") call _emptyString;
 	_image = getText(_x >> "image") call _emptyString;
-	
+
 	// tobool
 	_timestamp = _timestamp isEqualTo 1;
 
@@ -66,4 +78,4 @@ private ["_title","_description","_url","_color","_timestamp","_thumbnail","_ima
 	_embeds set [_forEachIndex,[_title,_description,_url,_color,_timestamp,_thumbnail,_image,_author,_footer,_fields]];
 } foreach _embeds;
 
-[_webhookurl,_message,_username,_avatar,_tts,_embeds] call DiscordEmbedBuilder_fnc_send;
+[_webhookurl,_message,_username,_avatar,_tts,_embeds] call DiscordEmbedBuilder_fnc_send;
diff --git a/addon/pbo/fn_buildSqf.sqf b/addon/pbo/fn_buildSqf.sqf
@@ -1,10 +1,22 @@
-/*──────────────────────────────────────────────────────┐
-│   Author: Connor                                      │
-│   Steam:  https://steamcommunity.com/id/_connor       │
-│   Github: https://github.com/ConnorAU                 │
-│                                                       │
-│   Please do not modify or remove this comment block   │
-└──────────────────────────────────────────────────────*/
+/* ----------------------------------------------------------------------------
+Project:
+	https://github.com/ConnorAU/SQFDiscordEmbedBuilder
+
+Author:
+	ConnorAU - https://github.com/ConnorAU
+
+Function:
+	DiscordEmbedBuilder_fnc_buildSqf
+
+Description:
+	Builds a message from the sqf provided
+
+Information:
+	https://github.com/ConnorAU/SQFDiscordEmbedBuilder/wiki/Build-with-SQF
+
+Return:
+	BOOL - true if the message was sent to the extension
+---------------------------------------------------------------------------- */
 
 /*
 Example 1:

diff --git a/addon/pbo/fn_init.sqf b/addon/pbo/fn_init.sqf
@@ -1,10 +1,16 @@
-/*──────────────────────────────────────────────────────┐
-│   Author: Connor                                      │
-│   Steam:  https://steamcommunity.com/id/_connor       │
-│   Github: https://github.com/ConnorAU                 │
-│                                                       │
-│   Please do not modify or remove this comment block   │
-└──────────────────────────────────────────────────────*/
+/* ----------------------------------------------------------------------------
+Project:
+	https://github.com/ConnorAU/SQFDiscordEmbedBuilder
+
+Author:
+	ConnorAU - https://github.com/ConnorAU
+
+Function:
+	DiscordEmbedBuilder_fnc_init
+
+Description:
+	Initialises the discord embed builder mod
+---------------------------------------------------------------------------- */
 
 with uiNamespace do {
 	DiscordEmbedBuilder_SessionKey = compileFinal str("DiscordEmbedBuilder" callExtension "init");
@@ -14,4 +20,4 @@ with uiNamespace do {
 	} else {
 		diag_log parseText "DiscordEmbedBuilder failed to load";
 	};
-};
+};
diff --git a/addon/pbo/fn_send.sqf b/addon/pbo/fn_send.sqf
@@ -1,10 +1,19 @@
-/*──────────────────────────────────────────────────────┐
-│   Author: Connor                                      │
-│   Steam:  https://steamcommunity.com/id/_connor       │
-│   Github: https://github.com/ConnorAU                 │
-│                                                       │
-│   Please do not modify or remove this comment block   │
-└──────────────────────────────────────────────────────*/
+/* ----------------------------------------------------------------------------
+Project:
+	https://github.com/ConnorAU/SQFDiscordEmbedBuilder
+
+Author:
+	ConnorAU - https://github.com/ConnorAU
+
+Function:
+	DiscordEmbedBuilder_fnc_send
+
+Description:
+	Sends a built message to the extension to execute a discord webhook
+
+Return:
+	BOOL - true if the message was sent to the extension
+---------------------------------------------------------------------------- */
 
 if !(uiNamespace getVariable ["DiscordEmbedBuilder_LoadSuccess",false]) exitwith {false};
 
@@ -19,4 +28,4 @@ params [
 
 private _key = uiNamespace getVariable ["DiscordEmbedBuilder_SessionKey",{""}];
 "DiscordEmbedBuilder" callExtension [call _key,[_webhookurl,_message,_username,_avatar,_tts,_embeds]];
-true
+true