refactor: remove extra comments

src/app/error.ts

@@ -7,7 +7,8 @@ import type { Parameters } from '#shared';
 /**
  * Handles an error.
  *
- * @param {string} message - The error message.
+ * @param {string|array} message - The error message,
+ * @prop {''} or @prop {['', { length: number }]}.
  *
  * @param {boolean} [hasTime=true] - Indicates if the error has a timestamp.
  *

src/app/info.ts

@@ -7,7 +7,8 @@ import type { Parameters } from '#shared';
 /**
  * Handles an info.
  *
- * @param {string} message - The info message.
+ * @param {string|array} message - The info message,
+ * @prop {''} or @prop {['', { length: number }]}.
  *
  * @param {boolean} [hasTime=true] - Indicates if the info has a timestamp.
  *

src/app/success.ts

@@ -7,7 +7,8 @@ import type { Parameters } from '#shared';
 /**
  * Handles an success.
  *
- * @param {string} message - The success message.
+ * @param {string|array} message - The success message,
+ * @prop {''} or @prop {['', { length: number }]}.
  *
  * @param {boolean} [hasTime=true] - Indicates if the success has a timestamp.
  *

src/app/warning.ts

@@ -7,7 +7,8 @@ import type { Parameters } from '#shared';
 /**
  * Handles an warning.
  *
- * @param {string} message - The warning message.
+ * @param {string|array} message - The warning message,
+ * @prop {''} or @prop {['', { length: number }]}.
  *
  * @param {boolean} [hasTime=true] - Indicates if the warning has a timestamp.
  *

src/features/generators/notification/index.ts

@@ -4,18 +4,6 @@ import { currentTime, truncate } from '#helpers';
 
 import type { Parameters } from './parameters.ts';
 
-/**
- * Generates a notification message.
- *
- * @param {string} message - The main message content of the notification.
- *
- * @param {string} title - The title of the notification.
- *
- * @param {boolean} hasTime - Indicates if the notification includes a timestamp.
- *
- * @return {string} - The formatted notification message with optional
- * timestamp, title, and optional truncated body.
- */
 const notificationGenerator = async (parameters: Parameters) => {
   const { message, title, hasTime } = parameters;
 

src/features/helpers/current-time.ts

@@ -1,4 +1,3 @@
-/** @return time as a string in the format of HH:MM:SS. */
 const currentTime = async () => new Date().toLocaleTimeString();
 
 export { currentTime };

src/features/helpers/truncate/index.ts

@@ -1,15 +1,5 @@
 import type { Parameters } from './parameters.ts';
 
-/**
- * Truncates a string or array message based on the specified length.
- *
- * @param {string | Array} message - The message to be truncated.
- *
- * @param {number} [length=Infinity] - The message to be truncated.
- *
- * @return {string} - The truncated message if it's length exceeds
- * the specified length, otherwise the original message.
- */
 const truncate = async (parameters: Parameters) => {
   const { message } = parameters;
 

src/features/log-level/index.ts

@@ -6,19 +6,6 @@ import { notificationGenerator } from '#generators';
 
 import type { Parameters } from './parameters.ts';
 
-/**
- * Logs a message with a specified log level.
- *
- * @param {string} message - The message to be logged.
- *
- * @param {string} title - The log level of the message.
- *
- * @param {boolean} hasTime - Indicates if the log should
- * include a timestamp.
- *
- * @return {void} - Logs the message with the specified log level
- * using console methods.
- */
 const logLevel = async (parameters: Parameters) => {
   const { message, title, hasTime } = parameters;
 

src/features/notifier/index.ts

@@ -4,17 +4,6 @@ import { truncate } from '#helpers';
 
 import type { Parameters } from './parameters.ts';
 
-/**
- * Notifies.
- *
- * @param {string} icon - The icon for the notification.
- *
- * @param {string} message - The message content of the notification.
- *
- * @param {string} title - The title of the notification.
- *
- * @return {Promise} - A promise that resolves to the notification result.
- */
 const notifier = async (parameters: Parameters) => {
   const { icon, message, title } = parameters;
 

src/features/splitter/index.ts

@@ -3,23 +3,6 @@ import { notifier } from '../notifier/index.ts';
 
 import type { Parameters } from './parameters.ts';
 
-/**
- * Splits the notification based on the notification mode
- * and performs the corresponding action.
- *
- * @param {string} icon - The icon for the notification.
- *
- * @param {string} title - The title of the notification.
- *
- * @param {string} message - The message content of the notification.
- *
- * @param {boolean} hasTime - Indicates if the notification includes a timestamp.
- *
- * @param {string} notificationMode - The mode of notification
- * ('console', 'desktop' or 'multiple').
- *
- * @returns {Object|Array} - The result of the notification action based on the mode.
- */
 const splitter = async (parameters: Parameters) => {
   const { icon, title, message, hasTime, notificationMode } = parameters;