From 4e8cbfe9e832383f149af6d84e2dc366d883c892 Mon Sep 17 00:00:00 2001
From: Ivan Yarcev <yarcev.id@ublinux.ru>
Date: Wed, 18 Dec 2024 10:21:33 +0600
Subject: [PATCH] comments added

---
 source/libublsettings.h | 81 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)

diff --git a/source/libublsettings.h b/source/libublsettings.h
index b1a83d3..a2cea25 100644
--- a/source/libublsettings.h
+++ b/source/libublsettings.h
@@ -530,18 +530,55 @@ int yon_char_parsed_divide_full(config_str parsed,int size,int divide_pos);
 
 int yon_char_parsed_divide_search_full(config_str parsed,int size,char *divide_pos, int delete_divider);
 
+/**yon_char_parsed_convert_to_dictionary(config_str parsed, int size)
+ * [EN]
+ * 
+ * [RU]
+ * Конвертирует массив строк [parsed] размера [size] в словарь типа dictionary*
+ */
 dictionary *yon_char_parsed_convert_to_dictionary(config_str parsed, int size);
 
+/**yon_char_parsed_convert_copy_to_dictionary(config_str parsed, int size)
+ * [EN]
+ * 
+ * [RU]
+ * Копирует массив строк [parsed] размера [size] в словарь типа dictionary*
+ */
 dictionary *yon_char_parsed_convert_copy_to_dictionary(config_str parsed, int size);
 
+/**yon_char_parsed_convert_copy_to_dictionary(config_str parsed, int size)
+ * [EN]
+ * 
+ * [RU]
+ * Конвертирует массив строк [parsed] размера [size] в строку, вставляя в местах соединений строку [divider_replace]
+ */
 char *yon_char_parsed_to_string(config_str parsed, int size, char *divider_replace);
 
+/**yon_char_parsed_to_string_for_iters(config_str parsed, int size, char *divider_replace,int iterations)
+ * [EN]
+ * 
+ * [RU]
+ * Конвертирует [iterations] первых элементов массива строк [parsed] размера [size] в строку,
+ * вставляя в местах соединений строку [divider_replace] 
+ */
 char *yon_char_parsed_to_string_for_iters(config_str parsed, int size, char *divider_replace,int iterations);
 
+/**yon_char_parsed_cut(config_str parsed, int size, int pos)
+ * [EN]
+ * 
+ * [RU]
+ * Создаёт новый массив строк из первых [pos] элементов массива строк [parsed] размера [size]
+ */
 config_str yon_char_parsed_cut(config_str parsed, int size, int pos);
 
 int yon_char_find_last_symbol_before_length(char *string, char target, int length);
 
+/**yon_char_wrap_to_length(char *target, unsigned int length, int *size)
+ * [EN]
+ * 
+ * [RU]
+ * Разделяет строку [target] на отрезки длиной до [length] символов каждый и возвращает массив длиной [size]
+ */
 config_str yon_char_wrap_to_length(char *target, unsigned int length, int *size);
 
 /**yon_ubl_check_root()
@@ -589,8 +626,22 @@ config_str yon_ubl_get_all_users(int *user_size);
 */
 float yon_size_convert_automatic(int bytes, int *size);
 
+/**yon_get_size_get_from_letter(char size)
+ * [EN]
+ * 
+ * [RU]
+ * Функция для работы с конфигурацией ubconfig.
+ * Конвертировать символ размера (K, M, G, T) в множитель для перевода размера в байты
+ */
 int yon_get_size_get_from_letter(char size);
 
+/**yon_size_get_mod(int size)
+ * [EN]
+ * 
+ * [RU]
+ * Функция для работы с конфигурацией ubconfig.
+ * Конвертировать числовое представление размера из yon_get_size_get_from_letter() в символьное
+ */
 char *yon_size_get_mod(int size);
 
 apps *yon_apps_scan_and_parse_desktops(int *sizef);
@@ -599,6 +650,12 @@ void yon_apps_sort(apps *applist, int size);
 
 apps *yon_apps_get_by_name(apps *applist, char *name, int size);
 
+/**yon_file_path_proceed_spaces(char *path)
+ * [EN]
+ * 
+ * [RU]
+ * Оборачивает все пробелы в пути для правильной обработки
+ */
 char *yon_file_path_proceed_spaces(char *path);
 
 /**yon_file_open(char *file_path, int *size)
@@ -609,6 +666,12 @@ char *yon_file_path_proceed_spaces(char *path);
 */
 config_str yon_file_open(char *file_path, int *size);
 
+/**yon_file_save(char *file_path, char *text)
+ * [EN]
+ * 
+ * [RU]
+ * Сохранить текст [text] в файл по пути [file_path]. Если файла не существует, он создаётся
+ */
 int yon_file_save(char *file_path, char *text);
 
 /**yon_file_create(char *path, char *name, int rules)
@@ -637,10 +700,28 @@ int yon_file_create_full_path(char *path, int rules);
 */
 config_str yon_file_list_dirs (char *path, int *size);
 
+/**
+ * [EN]
+ * 
+ * [RU]
+ * Возвращает массив строк размера [size] с именами всех файлов и папок из директории [path]
+ */
 config_str yon_file_ls(char *path, int *size);
 
+/**yon_file_is_directory(const char *path)
+ * [EN]
+ * 
+ * [RU]
+ * Проверяет указывает ли путь [path] на директорию
+ */
 int yon_file_is_directory(const char *path);
 
+/**yon_dir_remove(const char *path)
+ * [EN]
+ * 
+ * [RU]
+ * Проверяет указывает ли путь [path] на директорию и удаляет её
+ */
 void yon_dir_remove(const char *path);
 
 /** yon_dir_get_contents(char *dir_path, int *size)