Merge pull request 'ISEPOS-2280 Added base loggers scripts' (#1) from ymlesni/shared-snippets:feature/ISEPOS-2280-mechanizm-raportowania-informacji-z-aplikacji-do-pliku-z-logami into main

Reviewed-on: episodes-platform/shared-snippets#1
Reviewed-by: h.siejkowski <h.siejkowski@noreply.example.org>
Reviewed-by: asia <asia@noreply.example.org>

matlab/logging/base_logger.m

@@ -10,6 +10,9 @@
 % It follows the Singleton pattern to ensure that only one instance of the logger
 % exists throughout the application.
 %
+% The log file is specified by the environment variable 'APP_LOG_FILE'. If
+% the variable is not set, a default file 'base-logger-log.log' is used.
+%
 % Properties:
 %   fid - (private) The file identifier for the log file. This is used to write logs.
 %
@@ -17,20 +20,20 @@
 %
 %   getInstance() - Retrieves the singleton instance of the logger.
 %
-%   trace(message) - Logs a message with TRACE level.
-%     @param message The message to log.
+%   trace(varargin) - Logs one or more messages with TRACE level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   debug(message) - Logs a message with DEBUG level.
-%     @param message The message to log.
+%   debug(varargin) - Logs one or more messages with DEBUG level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   info(message) - Logs a message with INFO level.
-%     @param message The message to log.
+%   info(varargin) - Logs one or more messages with INFO level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   warning(message) - Logs a message with WARNING level.
-%     @param message The message to log.
+%   warning(varargin) - Logs one or more messages with WARNING level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   error(message) - Logs a message with ERROR level.
-%     @param message The message to log.
+%   error(varargin) - Logs one or more messages with ERROR level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
 %   delete() - Destructor method that closes the file identifier when the logger is deleted.
 %

octave/logging/base_logger.m

@@ -10,6 +10,9 @@
 % It follows the Singleton pattern to ensure that only one instance of the logger
 % exists throughout the application.
 %
+% The log file is specified by the environment variable 'APP_LOG_FILE'. If
+% the variable is not set, a default file 'base-logger-log.log' is used.
+%
 % Properties:
 %   fid - (private) The file identifier for the log file. This is used to write logs.
 %
@@ -17,20 +20,20 @@
 %
 %   getInstance() - Retrieves the singleton instance of the logger.
 %
-%   trace(message) - Logs a message with TRACE level.
-%     @param message The message to log.
+%   trace(varargin) - Logs one or more messages with TRACE level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   debug(message) - Logs a message with DEBUG level.
-%     @param message The message to log.
+%   debug(varargin) - Logs one or more messages with DEBUG level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   info(message) - Logs a message with INFO level.
-%     @param message The message to log.
+%   info(varargin) - Logs one or more messages with INFO level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   warning(message) - Logs a message with WARNING level.
-%     @param message The message to log.
+%   warning(varargin) - Logs one or more messages with WARNING level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   error(message) - Logs a message with ERROR level.
-%     @param message The message to log.
+%   error(varargin) - Logs one or more messages with ERROR level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
 %   delete() - Destructor method that closes the file identifier when the logger is deleted.
 %