docs: enhance IterableLogger documentation with descriptions and examples

Author: lposen

src/core/classes/IterableLogger.ts

@@ -37,7 +37,9 @@ export class IterableLogger {
   static loggingEnabled = DEFAULT_LOGGING_ENABLED;
 
   /**
-   * The level of logging to show in the developer console.
+   * The level of logging.
+   *
+   * This controls which logs will show when using the {@link IterableLogger.error}, {@link IterableLogger.debug}, and {@link IterableLogger.info} methods.
    */
   static logLevel = DEFAULT_LOG_LEVEL;
 
@@ -67,6 +69,11 @@ export class IterableLogger {
    * Logs a message to the console if logging is enabled.
    *
    * @param message - The message to be logged.
+   *
+   * @example
+   * ```typescript
+   * IterableLogger.log('I will show if logging is enabled');
+   * ```
    */
   static log(message?: unknown, ...optionalParams: unknown[]) {
     if (!IterableLogger.loggingEnabled) return;
@@ -75,9 +82,14 @@ export class IterableLogger {
   }
 
   /**
-   * Logs a message to the console if the log level is error.
+   * Logs a message to the console if the log level is {@link IterableLogLevel.error}.
    *
    * @param message - The message to be logged.
+   *
+   * @example
+   * ```typescript
+   * IterableLogger.error('I will only show if the log level is error and logging is enabled');
+   * ```
    */
   static error(message?: unknown, ...optionalParams: unknown[]) {
     if (!IterableLogger.loggingEnabled) return;
@@ -87,9 +99,15 @@ export class IterableLogger {
   }
 
   /**
-   * Logs a message to the console if the log level is debug or lower.
+   * Logs a message to the console if the log level is {@link IterableLogLevel.debug} or lower.
    *
    * @param message - The message to be logged.
+   *
+   * @example
+   * ```typescript
+   * IterableLogger.debug('I will show if the log level is debug and logging is enabled');
+   * IterableLogger.debug('I will also show if the log level is error and logging is enabled');
+   * ```
    */
   static debug(message?: unknown, ...optionalParams: unknown[]) {
     if (!IterableLogger.loggingEnabled) return;
@@ -104,9 +122,16 @@ export class IterableLogger {
   }
 
   /**
-   * Logs a message to the console if the log level is info or lower.
+   * Logs a message to the console if the log level is {@link IterableLogLevel.info} or lower.
    *
    * @param message - The message to be logged.
+   *
+   * @example
+   * ```typescript
+   * IterableLogger.info('I will show if the log level is info and logging is enabled');
+   * IterableLogger.info('I will also show if the log level is debug and logging is enabled');
+   * IterableLogger.info('I will also show if the log level is error and logging is enabled');
+   * ```
    */
   static info(message?: unknown, ...optionalParams: unknown[]) {
     if (!IterableLogger.loggingEnabled) return;