diff --git a/source/libublsettings.h b/source/libublsettings.h index 0043b74..4bdc957 100644 --- a/source/libublsettings.h +++ b/source/libublsettings.h @@ -1587,24 +1587,34 @@ int yon_config_force_save_registered(char *path); config_str yon_config_find_keys(char *target, int *size); -/**yon_config_get_all(int *size) - * [EN] - * - * [RU] - * Возвращает массив со всеми параметрами конфига, оканчивающаяся NULL - * [size] - указатель, в который выгружается длина массива -*/ +/// @brief Get all configuration parameters list +/// @param size A pointer for returning list's size +/// @return A newly allocated list of parameter keys; config_str yon_config_get_all(int *size); +/// @brief Get all modified configuration parameters +/// @param size A pointer for returning list's size +/// @return A newly allocated list of parameter keys; config_str yon_config_get_all_modified(int *size); +/// @brief Get all configuration parameters, which were not marked as ignored. +/// @param size A pointer for returning list's size +/// @return A newly allocated list of parameter keys; config_str yon_config_get_all_no_ignored(int *size); /*Возвращает ключ из параметра, или сам параметр если ключ не был найден*/ char *yon_config_parameter_get_key(char *parameter_string); - +/// @brief Move configuration parameter to be before another parameter. Used to sort parameters for saving if a precise saving order is required +/// @param parameter Moved configuration parameter; +/// @param target Parameter to which the required parameter will be moved +/// @return TRUE if succeeded, FALSE otherwise int yon_config_move_before(char *parameter, char *target); + +/// @brief Move configuration parameter to be after another parameter. Used to sort parameters for saving if a precise saving order is required +/// @param parameter Moved configuration parameter; +/// @param target Parameter to which the required parameter will be moved +/// @return TRUE if succeeded, FALSE otherwise int yon_config_move_after(char *parameter, char *target); /// @brief Revert configuration to default values. @@ -1670,22 +1680,17 @@ int yon_config_custom_swap(yon_config_custom **target); /// @brief Apply custom config to internal config. Remove all parameters and insert custom configuration; /// @return TRUE if applied successfully, FALSE otherwise int yon_config_custom_apply(yon_config_custom **target); + // terminal-using functions -/**yon_launch_app_with_arguments(char *name, char *args) - * [EN] - * Execute [command] in separate thread; - * [RU] - * Выполнить команду [command] в отдельном потоке; -*/ -int yon_launch_app_with_arguments(char *name, char *args); +/// @brief Execute command in separate thread +/// @param command Command to execute +/// @param args arguments, adding to command, can be NULL; +/// @return returned status of command execution. +int yon_launch_app_with_arguments(char *command, char *args); -/**yon_launch(char *command) - * [EN] - * Execute command [command] - * [RU] - * Выполнить команду [command] -*/ +/// @brief Execute a command +/// @param command Command to execute void yon_launch(char *command); // // Trash collector functions