episodes-platform/shared-snippets
3
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ISEPOS-2280 Adjusted javadoc of newer matlab and octave logger versions

Browse Source
This commit is contained in:
plgmlesniak 2024-10-15 20:43:18 +02:00
parent 7ba8869df0
commit be2d4ffa36
2 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
matlab/logging/base_logger.m
View File

@ -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.
%

23
octave/logging/base_logger.m
View File

@ -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.
%