update javadoc

Author: JavaSaBr

rlib-classpath/src/main/java/javasabr/rlib/classpath/ClassPathScanner.java

@@ -10,16 +10,35 @@
 import org.jspecify.annotations.Nullable;
 
 /**
- * @author JavaSaBr
+ * Scanner for discovering classes and resources on the classpath.
+ *
+ * @since 10.0.0
  */
 public interface ClassPathScanner {
 
+  /**
+   * The JAR file extension.
+   */
   String JAR_EXTENSION = ".jar";
+
+  /**
+   * The Java source file extension.
+   */
   String SOURCE_EXTENSION = ".java";
+
+  /**
+   * The compiled class file extension.
+   */
   String CLASS_EXTENSION = ".class";
 
+  /**
+   * A null scanner constant.
+   */
   @Nullable ClassPathScanner NULL_SCANNER = null;
 
+  /**
+   * An empty scanner that performs no operations.
+   */
   ClassPathScanner EMPTY_SCANNER = new ClassPathScannerImpl(ClassPathScanner.class.getClassLoader()) {
 
     @Override
@@ -38,55 +57,172 @@ public void addResources(Array<String> resources) {}
     public void scan(Predicate<String> filter) {}
   };
 
+  /**
+   * An empty class loader with no URLs.
+   */
   URLClassLoader EMPTY_CLASS_LOADER = new URLClassLoader(new URL[0], ClassPathScanner.class.getClassLoader());
 
+  /**
+   * A null class loader constant.
+   */
   @Nullable URLClassLoader NULL_CLASS_LOADER = null;
 
+  /**
+   * Adds discovered classes to the specified collection.
+   *
+   * @param classes the collection to add classes to
+   * @since 10.0.0
+   */
   void addClasses(Array<Class<?>> classes);
 
+  /**
+   * Adds discovered resources to the specified collection.
+   *
+   * @param resources the collection to add resources to
+   * @since 10.0.0
+   */
   void addResources(Array<String> resources);
 
+  /**
+   * Sets whether to include the system classpath in scanning.
+   *
+   * @param useSystemClasspath true to include system classpath
+   * @since 10.0.0
+   */
   void useSystemClassPath(boolean useSystemClasspath);
 
+  /**
+   * Finds all implementations of the specified interface.
+   *
+   * @param <T> the type of the interface
+   * @param interfaceClass the interface class to find implementations for
+   * @return an array of implementing classes
+   * @since 10.0.0
+   */
   default <T> Array<Class<T>> findImplementations(Class<T> interfaceClass) {
     MutableArray<Class<T>> result = MutableArray.ofType(Class.class);
     findImplementationsTo(result, interfaceClass);
     return result;
   }
 
+  /**
+   * Finds all implementations of the specified interface and adds them to the container.
+   *
+   * @param <T> the type of the interface
+   * @param container the container to add implementations to
+   * @param interfaceClass the interface class to find implementations for
+   * @since 10.0.0
+   */
   <T> void findImplementationsTo(MutableArray<Class<T>> container, Class<T> interfaceClass);
 
+  /**
+   * Finds all classes that inherit from the specified parent class.
+   *
+   * @param <T> the type of the parent class
+   * @param parentClass the parent class to find subclasses for
+   * @return an array of subclasses
+   * @since 10.0.0
+   */
   default <T> Array<Class<T>> findInherited(Class<T> parentClass) {
     MutableArray<Class<T>> result = MutableArray.ofType(Class.class);
     findInheritedTo(result, parentClass);
     return result;
   }
 
+  /**
+   * Finds all classes that inherit from the specified parent class and adds them to the container.
+   *
+   * @param <T> the type of the parent class
+   * @param container the container to add subclasses to
+   * @param parentClass the parent class to find subclasses for
+   * @since 10.0.0
+   */
   <T> void findInheritedTo(MutableArray<Class<T>> container, Class<T> parentClass);
 
+  /**
+   * Finds all classes annotated with the specified annotation.
+   *
+   * @param annotationClass the annotation class to search for
+   * @return an array of annotated classes
+   * @since 10.0.0
+   */
   default Array<Class<?>> findAnnotated(Class<? extends Annotation> annotationClass) {
     MutableArray<Class<?>> result = MutableArray.ofType(Class.class);
     findAnnotatedTo(result, annotationClass);
     return result;
   }
 
+  /**
+   * Finds all classes annotated with the specified annotation and adds them to the container.
+   *
+   * @param container the container to add annotated classes to
+   * @param annotationClass the annotation class to search for
+   * @since 10.0.0
+   */
   void findAnnotatedTo(MutableArray<Class<?>> container, Class<? extends Annotation> annotationClass);
 
+  /**
+   * Adds all found classes to the specified container.
+   *
+   * @param container the container to add classes to
+   * @since 10.0.0
+   */
   void foundClassesTo(MutableArray<Class<?>> container);
 
+  /**
+   * Adds all found resources to the specified container.
+   *
+   * @param container the container to add resources to
+   * @since 10.0.0
+   */
   void foundResourcesTo(MutableArray<String> container);
 
+  /**
+   * Returns all classes found during scanning.
+   *
+   * @return an array of found classes
+   * @since 10.0.0
+   */
   Array<Class<?>> foundClasses();
 
+  /**
+   * Returns all resources found during scanning.
+   *
+   * @return an array of found resource paths
+   * @since 10.0.0
+   */
   Array<String> foundResources();
 
+  /**
+   * Scans the classpath without any filter.
+   *
+   * @since 10.0.0
+   */
   default void scan() {
     scan(null);
   }
 
+  /**
+   * Scans the classpath with the specified filter.
+   *
+   * @param filter the filter to apply during scanning, or null for no filter
+   * @since 10.0.0
+   */
   void scan(@Nullable Predicate<String> filter);
 
+  /**
+   * Adds an additional path to scan.
+   *
+   * @param path the path to add
+   * @since 10.0.0
+   */
   void addAdditionalPath(String path);
 
+  /**
+   * Adds additional paths to scan.
+   *
+   * @param paths the paths to add
+   * @since 10.0.0
+   */
   void addAdditionalPaths(String[] paths);
 }

rlib-classpath/src/main/java/javasabr/rlib/classpath/ClassPathScannerFactory.java

@@ -4,18 +4,41 @@
 import javasabr.rlib.classpath.impl.ManifestClassPathScannerImpl;
 
 /**
- * @author JavaSaBr
+ * Factory for creating {@link ClassPathScanner} instances.
+ *
+ * @since 10.0.0
  */
 public final class ClassPathScannerFactory {
 
+  /**
+   * Creates a new default scanner using the factory's class loader.
+   *
+   * @return a new classpath scanner
+   * @since 10.0.0
+   */
   public static ClassPathScanner newDefaultScanner() {
     return new ClassPathScannerImpl(ClassPathScannerFactory.class.getClassLoader());
   }
 
+  /**
+   * Creates a new default scanner using the specified class loader.
+   *
+   * @param classLoader the class loader to use
+   * @return a new classpath scanner
+   * @since 10.0.0
+   */
   public static ClassPathScanner newDefaultScanner(ClassLoader classLoader) {
     return new ClassPathScannerImpl(classLoader);
   }
 
+  /**
+   * Creates a new default scanner using the specified class loader and additional paths.
+   *
+   * @param classLoader the class loader to use
+   * @param additionalPaths additional paths to scan
+   * @return a new classpath scanner
+   * @since 10.0.0
+   */
   public static ClassPathScanner newDefaultScanner(
       ClassLoader classLoader,
       String[] additionalPaths) {
@@ -24,13 +47,28 @@ public static ClassPathScanner newDefaultScanner(
     return scanner;
   }
 
+  /**
+   * Creates a new manifest-based scanner that reads classpath entries from the JAR manifest.
+   *
+   * @param rootClass the class whose JAR manifest should be read
+   * @return a new manifest-based scanner
+   * @since 10.0.0
+   */
   public static ClassPathScanner newManifestScanner(Class<?> rootClass) {
     return new ManifestClassPathScannerImpl(
         ClassPathScannerFactory.class.getClassLoader(),
         rootClass,
         "Class-Path");
   }
 
+  /**
+   * Creates a new manifest-based scanner with a custom classpath key.
+   *
+   * @param rootClass the class whose JAR manifest should be read
+   * @param classPathKey the manifest attribute key for classpath entries
+   * @return a new manifest-based scanner
+   * @since 10.0.0
+   */
   public static ClassPathScanner newManifestScanner(Class<?> rootClass, String classPathKey) {
     return new ManifestClassPathScannerImpl(
         ClassPathScannerFactory.class.getClassLoader(),

rlib-compiler/src/main/java/javasabr/rlib/compiler/CompiledClassData.java

@@ -1,13 +1,33 @@
 package javasabr.rlib.compiler;
 
 /**
- * @author JavaSaBr
+ * Represents compiled class bytecode data.
+ *
+ * @since 10.0.0
  */
 public interface CompiledClassData {
 
+  /**
+   * Returns the compiled bytecode of the class.
+   *
+   * @return the bytecode array
+   * @since 10.0.0
+   */
   byte[] byteCode();
 
+  /**
+   * Returns the size of the bytecode in bytes.
+   *
+   * @return the bytecode size
+   * @since 10.0.0
+   */
   int size();
 
+  /**
+   * Returns the fully qualified name of the compiled class.
+   *
+   * @return the class name
+   * @since 10.0.0
+   */
   String name();
 }

rlib-compiler/src/main/java/javasabr/rlib/compiler/Compiler.java

@@ -5,16 +5,46 @@
 import javasabr.rlib.collections.array.Array;
 
 /**
- * @author JavaSaBr
+ * Runtime Java compiler interface for compiling Java source files.
+ *
+ * @since 10.0.0
  */
 public interface Compiler {
 
+  /**
+   * The Java source file extension.
+   */
   String SOURCE_EXTENSION = ".java";
+
+  /**
+   * The compiled class file extension.
+   */
   String CLASS_EXTENSION = ".class";
 
+  /**
+   * Compiles Java source files from the specified URIs.
+   *
+   * @param urls the URIs of the source files to compile
+   * @return an array of compiled classes
+   * @since 10.0.0
+   */
   Array<Class<?>> compileByUrls(Array<URI> urls);
 
+  /**
+   * Compiles Java source files from the specified paths.
+   *
+   * @param files the paths to the source files to compile
+   * @return an array of compiled classes
+   * @since 10.0.0
+   */
   Array<Class<?>> compileFiles(Array<Path> files);
 
+  /**
+   * Compiles all Java source files in the specified directories.
+   *
+   * @param directories the directories containing source files to compile
+   * @return an array of compiled classes
+   * @since 10.0.0
+   */
   Array<Class<?>> compileDirectories(Array<Path> directories);
 }

rlib-compiler/src/main/java/javasabr/rlib/compiler/CompilerFactory.java

@@ -6,18 +6,29 @@
 import lombok.NoArgsConstructor;
 
 /**
- * @author JavaSaBr
+ * Factory for creating {@link Compiler} instances.
+ *
+ * @since 10.0.0
  */
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 public class CompilerFactory {
 
   /**
-   * Check availability compiler API in current runtime.
+   * Checks if the compiler API is available in the current runtime.
+   *
+   * @return true if the compiler is available
+   * @since 10.0.0
    */
   public static boolean isAvailableCompiler() {
     return ToolProvider.getSystemJavaCompiler() != null;
   }
 
+  /**
+   * Creates a new default compiler instance.
+   *
+   * @return a new compiler
+   * @since 10.0.0
+   */
   public static Compiler newDefaultCompiler() {
     return new JdkCompiler(true);
   }