From 537e50aa82ac1606dada32a7aca7b7df0be5ff22 Mon Sep 17 00:00:00 2001 From: Summet-V Date: Fri, 24 Jul 2020 12:57:52 +0300 Subject: [PATCH] Docs --- docs/ColorSwitcher.html | 4 +- docs/Console.html | 34 ++-- docs/GearIcon.html | 4 +- docs/Generator.html | 4 +- docs/Keybinds.html | 4 +- docs/Menu.html | 4 +- docs/Players.html | 4 +- docs/Server.html | 4 +- docs/ServerApplication.html | 4 +- docs/ServerWindow.html | 4 +- docs/Titlebar.html | 4 +- docs/Translations.html | 4 +- docs/global.html | 160 +++++++++++++++++- docs/index.html | 4 +- docs/main-process_main.js.html | 4 +- docs/main-process_server-application.js.html | 4 +- docs/main-process_server-window.js.html | 4 +- docs/main-process_server.js.html | 4 +- docs/main-process_utils_error-handler.js.html | 4 +- ...n-process_utils_parse-command-line.js.html | 4 +- ...main-process_utils_server-messages.js.html | 4 +- docs/window_components_color-switcher.js.html | 4 +- .../window_components_console_console.js.html | 5 +- docs/window_components_keybinds.js.html | 4 +- docs/window_components_menu_menu.js.html | 4 +- .../window_components_players_players.js.html | 4 +- ...indow_components_titlebar_titlebar.js.html | 4 +- docs/window_components_translations.js.html | 4 +- ...ustom-elements_gear-icon_gear-icon.js.html | 4 +- docs/window_utils_color-parser.js.html | 21 ++- docs/window_utils_generator.js.html | 4 +- docs/window_utils_os-utils.js.html | 4 +- docs/window_window.js.html | 4 +- 33 files changed, 247 insertions(+), 89 deletions(-) diff --git a/docs/ColorSwitcher.html b/docs/ColorSwitcher.html index b62f432..770dc1b 100644 --- a/docs/ColorSwitcher.html +++ b/docs/ColorSwitcher.html @@ -643,13 +643,13 @@

update
- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/Console.html b/docs/Console.html index 3b40e0d..c036f26 100644 --- a/docs/Console.html +++ b/docs/Console.html @@ -97,7 +97,7 @@

new ConsoleSource:
@@ -277,7 +277,7 @@
Parameters:
Source:
@@ -437,7 +437,7 @@
Parameters:
Source:
@@ -597,7 +597,7 @@
Parameters:
Source:
@@ -685,7 +685,7 @@

clearInput<
Source:
@@ -773,7 +773,7 @@

clearLogSource:
@@ -861,7 +861,7 @@

exitSource:
@@ -998,7 +998,7 @@
Parameters:
Source:
@@ -1086,7 +1086,7 @@

restartSource:
@@ -1174,7 +1174,7 @@

scrollDown<
Source:
@@ -1262,7 +1262,7 @@

setupSource:
@@ -1350,7 +1350,7 @@

setupKey
Source:
@@ -1438,7 +1438,7 @@

switchColo
Source:
@@ -1526,7 +1526,7 @@

switchD
Source:
@@ -1614,7 +1614,7 @@

switchLang<
Source:
@@ -1660,13 +1660,13 @@

switchLang<
- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/GearIcon.html b/docs/GearIcon.html index bf9369c..5af669a 100644 --- a/docs/GearIcon.html +++ b/docs/GearIcon.html @@ -164,13 +164,13 @@

Example

- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/Generator.html b/docs/Generator.html index 4c2a3f2..8711c6c 100644 --- a/docs/Generator.html +++ b/docs/Generator.html @@ -269,13 +269,13 @@
Returns:

- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/Keybinds.html b/docs/Keybinds.html index aa8dd7b..7ddf45f 100644 --- a/docs/Keybinds.html +++ b/docs/Keybinds.html @@ -483,13 +483,13 @@
Parameters:

- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/Menu.html b/docs/Menu.html index bcf3362..5826914 100644 --- a/docs/Menu.html +++ b/docs/Menu.html @@ -1271,13 +1271,13 @@
Returns:

- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/Players.html b/docs/Players.html index 26fd7ff..a48dddd 100644 --- a/docs/Players.html +++ b/docs/Players.html @@ -613,13 +613,13 @@

updatePl
- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/Server.html b/docs/Server.html index d85696b..2bad310 100644 --- a/docs/Server.html +++ b/docs/Server.html @@ -1560,13 +1560,13 @@

Parameters:

- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/ServerApplication.html b/docs/ServerApplication.html index 4b4aab1..547674c 100644 --- a/docs/ServerApplication.html +++ b/docs/ServerApplication.html @@ -441,13 +441,13 @@
Properties

- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/ServerWindow.html b/docs/ServerWindow.html index 0ed436e..e194319 100644 --- a/docs/ServerWindow.html +++ b/docs/ServerWindow.html @@ -383,13 +383,13 @@

han
- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/Titlebar.html b/docs/Titlebar.html index 5024cff..f6a0c87 100644 --- a/docs/Titlebar.html +++ b/docs/Titlebar.html @@ -251,13 +251,13 @@

setHome

Classes

Global

+

Home

Classes

Global


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/Translations.html b/docs/Translations.html index 094e0bc..1dc401c 100644 --- a/docs/Translations.html +++ b/docs/Translations.html @@ -772,13 +772,13 @@

update
- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/global.html b/docs/global.html index f1ac375..48427f5 100644 --- a/docs/global.html +++ b/docs/global.html @@ -98,6 +98,150 @@

Members

+

(constant) colorRegex :RegExp

+ + + + +
+ Regular expression for checking colored strings. +
+ + + +
Type:
+
    +
  • + +RegExp + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

(constant) hexRegex :RegExp

+ + + + +
+ Regular expression for checking HEX colors. +
+ + + +
Type:
+
    +
  • + +RegExp + + +
  • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

(constant) serverMessages :Object

@@ -281,7 +425,7 @@
Parameters:
Source:
@@ -713,7 +857,7 @@
Parameters:
Source:
@@ -895,7 +1039,7 @@
Parameters:
Source:
@@ -1054,7 +1198,7 @@
Parameters:
Source:
@@ -1213,7 +1357,7 @@
Parameters:
Source:
@@ -1531,7 +1675,7 @@
Parameters:
Source:
@@ -1819,13 +1963,13 @@
Returns:

- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/index.html b/docs/index.html index e1545c7..5e3c679 100644 --- a/docs/index.html +++ b/docs/index.html @@ -68,13 +68,13 @@

Support


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/main-process_main.js.html b/docs/main-process_main.js.html index 94e27c3..1e7bd27 100644 --- a/docs/main-process_main.js.html +++ b/docs/main-process_main.js.html @@ -80,13 +80,13 @@

Source: main-process/main.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/main-process_server-application.js.html b/docs/main-process_server-application.js.html index f81143b..670378b 100644 --- a/docs/main-process_server-application.js.html +++ b/docs/main-process_server-application.js.html @@ -69,13 +69,13 @@

Source: main-process/server-application.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/main-process_server-window.js.html b/docs/main-process_server-window.js.html index df440c2..be2a13d 100644 --- a/docs/main-process_server-window.js.html +++ b/docs/main-process_server-window.js.html @@ -88,13 +88,13 @@

Source: main-process/server-window.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/main-process_server.js.html b/docs/main-process_server.js.html index 490e3e7..ad8bde7 100644 --- a/docs/main-process_server.js.html +++ b/docs/main-process_server.js.html @@ -201,13 +201,13 @@

Source: main-process/server.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/main-process_utils_error-handler.js.html b/docs/main-process_utils_error-handler.js.html index c38137e..057d4bb 100644 --- a/docs/main-process_utils_error-handler.js.html +++ b/docs/main-process_utils_error-handler.js.html @@ -53,13 +53,13 @@

Source: main-process/utils/error-handler.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/main-process_utils_parse-command-line.js.html b/docs/main-process_utils_parse-command-line.js.html index 96ff3b2..54d081e 100644 --- a/docs/main-process_utils_parse-command-line.js.html +++ b/docs/main-process_utils_parse-command-line.js.html @@ -60,13 +60,13 @@

Source: main-process/utils/parse-command-line.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/main-process_utils_server-messages.js.html b/docs/main-process_utils_server-messages.js.html index cfa689c..c8789dc 100644 --- a/docs/main-process_utils_server-messages.js.html +++ b/docs/main-process_utils_server-messages.js.html @@ -46,13 +46,13 @@

Source: main-process/utils/server-messages.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_components_color-switcher.js.html b/docs/window_components_color-switcher.js.html index 38e5eec..f99baa6 100644 --- a/docs/window_components_color-switcher.js.html +++ b/docs/window_components_color-switcher.js.html @@ -89,13 +89,13 @@

Source: window/components/color-switcher.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_components_console_console.js.html b/docs/window_components_console_console.js.html index 8f28b2d..813c827 100644 --- a/docs/window_components_console_console.js.html +++ b/docs/window_components_console_console.js.html @@ -28,7 +28,6 @@

Source: window/components/console/console.js

const { getCurrentWindow } = require('electron').remote;
 const { ipcRenderer } = require('electron');
-
 const Titlebar = require('../titlebar/titlebar');
 const Menu = require('../menu/menu');
 const Players = require('../players/players');
@@ -228,13 +227,13 @@ 

Source: window/components/console/console.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_components_keybinds.js.html b/docs/window_components_keybinds.js.html index 545239c..1fa5163 100644 --- a/docs/window_components_keybinds.js.html +++ b/docs/window_components_keybinds.js.html @@ -78,13 +78,13 @@

Source: window/components/keybinds.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_components_menu_menu.js.html b/docs/window_components_menu_menu.js.html index 231d401..c09f90a 100644 --- a/docs/window_components_menu_menu.js.html +++ b/docs/window_components_menu_menu.js.html @@ -156,13 +156,13 @@

Source: window/components/menu/menu.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_components_players_players.js.html b/docs/window_components_players_players.js.html index a503bfe..fecbfea 100644 --- a/docs/window_components_players_players.js.html +++ b/docs/window_components_players_players.js.html @@ -100,13 +100,13 @@

Source: window/components/players/players.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_components_titlebar_titlebar.js.html b/docs/window_components_titlebar_titlebar.js.html index eda50bc..162fdf9 100644 --- a/docs/window_components_titlebar_titlebar.js.html +++ b/docs/window_components_titlebar_titlebar.js.html @@ -83,13 +83,13 @@

Source: window/components/titlebar/titlebar.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_components_translations.js.html b/docs/window_components_translations.js.html index 7844571..56b267f 100644 --- a/docs/window_components_translations.js.html +++ b/docs/window_components_translations.js.html @@ -112,13 +112,13 @@

Source: window/components/translations.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_custom-elements_gear-icon_gear-icon.js.html b/docs/window_custom-elements_gear-icon_gear-icon.js.html index 20158ab..686e373 100644 --- a/docs/window_custom-elements_gear-icon_gear-icon.js.html +++ b/docs/window_custom-elements_gear-icon_gear-icon.js.html @@ -79,13 +79,13 @@

Source: window/custom-elements/gear-icon/gear-icon.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_utils_color-parser.js.html b/docs/window_utils_color-parser.js.html index 6974c0e..aeff7de 100644 --- a/docs/window_utils_color-parser.js.html +++ b/docs/window_utils_color-parser.js.html @@ -26,7 +26,16 @@

Source: window/utils/color-parser.js

-
const colorRegex = /\[(\w)+]/g;
+            
/**
+ * Regular expression for checking colored strings.
+ * @type {RegExp}
+ */
+const colorRegex = /\[(\w)+]/g;
+
+/**
+ * Regular expression for checking HEX colors.
+ * @type {RegExp}
+ */
 const hexRegex = /[0-9A-Fa-f]{6}/;
 
 /**
@@ -95,8 +104,11 @@ 

Source: window/utils/color-parser.js

} const coloredStrings = []; + let coloring = false; + for (let i = 0; i < name.length; i++) { if (name.charAt(i) === '[' && i !== name.length - 1 && name.charAt(i + 1) !== '[' && (i === 0 || name.charAt(i - 1) !== '[')) { + coloring = true; const next = name.substring(i); const result = checkColor(next); for (let j = 0; j < result.str.length; j++) { @@ -110,6 +122,9 @@

Source: window/utils/color-parser.js

? getHexColoredString(result.str, result.color) : getColoredString(result.str, result.color); coloredStrings.push(coloredString); + } else if (!coloring) { + const whiteString = getColoredString(name.charAt(i), 'white'); + coloredStrings.push(whiteString); } } return `<div class="colored">${coloredStrings.join('')}</div>`; @@ -126,13 +141,13 @@

Source: window/utils/color-parser.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_utils_generator.js.html b/docs/window_utils_generator.js.html index e57bde5..c0db26d 100644 --- a/docs/window_utils_generator.js.html +++ b/docs/window_utils_generator.js.html @@ -57,13 +57,13 @@

Source: window/utils/generator.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_utils_os-utils.js.html b/docs/window_utils_os-utils.js.html index 7d464ef..d0a1ad0 100644 --- a/docs/window_utils_os-utils.js.html +++ b/docs/window_utils_os-utils.js.html @@ -89,13 +89,13 @@

Source: window/utils/os-utils.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)
diff --git a/docs/window_window.js.html b/docs/window_window.js.html index 0918086..84ff212 100644 --- a/docs/window_window.js.html +++ b/docs/window_window.js.html @@ -49,13 +49,13 @@

Source: window/window.js


- Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 01:57:30 GMT+0300 (Москва, стандартное время) + Documentation generated by JSDoc 3.6.5 on Fri Jul 24 2020 12:57:19 GMT+0300 (Москва, стандартное время)