update javadoc

Author: JavaSaBr

rlib-logger-api/src/main/java/javasabr/rlib/logger/api/Logger.java

@@ -4,95 +4,180 @@
 import org.jspecify.annotations.NullUnmarked;
 
 /**
- * @author JavaSaBr
+ * Logger interface for outputting messages at different log levels.
+ *
+ * @since 10.0.0
  */
 @NullUnmarked
 public interface Logger {
 
+  /**
+   * Factory for creating log messages with no arguments.
+   *
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface Factory {
 
     @NonNull
     String make();
   }
 
+  /**
+   * Factory for creating log messages with one argument.
+   *
+   * @param <A> the type of the argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface N1Factory<A> {
 
     @NonNull
     String make(A arg1);
   }
 
+  /**
+   * Factory for creating log messages with one int argument.
+   *
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface IntFactory {
 
     @NonNull
     String make(int arg1);
   }
 
+  /**
+   * Factory for creating log messages with an int and an object argument.
+   *
+   * @param <B> the type of the object argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface IntN1Factory<B> {
 
     @NonNull
     String make(int arg1, B arg2);
   }
 
+  /**
+   * Factory for creating log messages with two arguments.
+   *
+   * @param <A> the type of the first argument
+   * @param <B> the type of the second argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface N2Factory<A, B> {
 
     @NonNull
     String make(A arg1, B arg2);
   }
 
+  /**
+   * Factory for creating log messages with an object and an int argument.
+   *
+   * @param <A> the type of the object argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface N1IntFactory<A> {
 
     @NonNull
     String make(A arg1, int arg2);
   }
 
+  /**
+   * Factory for creating log messages with an object and two int arguments.
+   *
+   * @param <A> the type of the object argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface N1Int2Factory<A> {
 
     @NonNull
     String make(A arg1, int arg2, int arg3);
   }
 
+  /**
+   * Factory for creating log messages with an object, an int, and another object argument.
+   *
+   * @param <A> the type of the first object argument
+   * @param <C> the type of the second object argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface N1IntN1Factory<A, C> {
 
     @NonNull
     String make(A arg1, int arg2, C arg3);
   }
 
+  /**
+   * Factory for creating log messages with two int arguments.
+   *
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface Int2Factory {
 
     @NonNull
     String make(int arg1, int arg2);
   }
 
+  /**
+   * Factory for creating log messages with three arguments.
+   *
+   * @param <A> the type of the first argument
+   * @param <B> the type of the second argument
+   * @param <C> the type of the third argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface N3Factory<A, B, C> {
 
     @NonNull
     String make(A arg1, B arg2, C arg3);
   }
 
+  /**
+   * Factory for creating log messages with two int and one object argument.
+   *
+   * @param <C> the type of the object argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface Int2N1Factory<C> {
 
     @NonNull
     String make(int arg1, int arg2, C arg3);
   }
 
+  /**
+   * Factory for creating log messages with an object, two ints, and another object argument.
+   *
+   * @param <A> the type of the first object argument
+   * @param <D> the type of the second object argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface N1Int2N1Factory<A, D> {
 
     @NonNull
     String make(A arg1, int arg2, int arg3, D arg4);
   }
 
+  /**
+   * Factory for creating log messages with four arguments.
+   *
+   * @param <A> the type of the first argument
+   * @param <B> the type of the second argument
+   * @param <C> the type of the third argument
+   * @param <D> the type of the fourth argument
+   * @since 10.0.0
+   */
   @FunctionalInterface
   interface N4Factory<A, B, C, D> {
 
@@ -101,9 +186,10 @@ interface N4Factory<A, B, C, D> {
   }
 
   /**
-   * Print the debug message.
+   * Prints a debug message.
    *
-   * @param message the message.
+   * @param message the message to print
+   * @since 10.0.0
    */
   default void debug(@NonNull String message) {
     print(LoggerLevel.DEBUG, message);

rlib-logger-api/src/main/java/javasabr/rlib/logger/api/LoggerFactory.java

@@ -2,19 +2,68 @@
 
 import java.io.Writer;
 
+/**
+ * Factory for creating {@link Logger} instances.
+ *
+ * @since 10.0.0
+ */
 public interface LoggerFactory {
 
+  /**
+   * Creates a logger with the specified name.
+   *
+   * @param name the logger name
+   * @return the logger instance
+   * @since 10.0.0
+   */
   Logger make(String name);
 
+  /**
+   * Creates a logger for the specified class.
+   *
+   * @param type the class to create a logger for
+   * @return the logger instance
+   * @since 10.0.0
+   */
   Logger make(Class<?> type);
 
+  /**
+   * Returns the default logger.
+   *
+   * @return the default logger
+   * @since 10.0.0
+   */
   Logger getDefault();
 
+  /**
+   * Adds a listener to receive log output.
+   *
+   * @param listener the listener to add
+   * @since 10.0.0
+   */
   void addListener(LoggerListener listener);
 
+  /**
+   * Removes a previously added listener.
+   *
+   * @param listener the listener to remove
+   * @since 10.0.0
+   */
   void removeListener(LoggerListener listener);
 
+  /**
+   * Adds a writer to receive log output.
+   *
+   * @param writer the writer to add
+   * @since 10.0.0
+   */
   void addWriter(Writer writer);
 
+  /**
+   * Removes a previously added writer.
+   *
+   * @param writer the writer to remove
+   * @since 10.0.0
+   */
   void removeWriter(Writer writer);
 }

rlib-logger-api/src/main/java/javasabr/rlib/logger/api/LoggerLevel.java

@@ -7,7 +7,9 @@
 import lombok.experimental.FieldDefaults;
 
 /**
- * @author JavaSaBr
+ * Enumeration of log levels.
+ *
+ * @since 10.0.0
  */
 @Getter
 @RequiredArgsConstructor
@@ -19,6 +21,9 @@ public enum LoggerLevel {
   WARNING("WARNING", "", true, true),
   ERROR("ERROR", "  ", true, true);
 
+  /**
+   * The number of log levels.
+   */
   public static final int LENGTH = values().length;
 
   String title;

rlib-logger-api/src/main/java/javasabr/rlib/logger/api/LoggerListener.java

@@ -1,11 +1,24 @@
 package javasabr.rlib.logger.api;
 
 /**
- * @author JavaSaBr
+ * Listener for receiving log output.
+ *
+ * @since 10.0.0
  */
 public interface LoggerListener {
 
+  /**
+   * Called when a log line is printed.
+   *
+   * @param text the log text
+   * @since 10.0.0
+   */
   void println(String text);
 
+  /**
+   * Called to flush any buffered output.
+   *
+   * @since 10.0.0
+   */
   default void flush() {}
 }