From be2d4ffa36977f85d34269ac5993259e064460dc Mon Sep 17 00:00:00 2001 From: plgmlesniak Date: Tue, 15 Oct 2024 20:43:18 +0200 Subject: [PATCH] ISEPOS-2280 Adjusted javadoc of newer matlab and octave logger versions --- matlab/logging/base_logger.m | 23 +++++++++++++---------- octave/logging/base_logger.m | 23 +++++++++++++---------- 2 files changed, 26 insertions(+), 20 deletions(-) diff --git a/matlab/logging/base_logger.m b/matlab/logging/base_logger.m index 09f8a66..516c1df 100644 --- a/matlab/logging/base_logger.m +++ b/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. % diff --git a/octave/logging/base_logger.m b/octave/logging/base_logger.m index 503bc11..3ef3da1 100644 --- a/octave/logging/base_logger.m +++ b/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. %