Add JavaDoc to factory again

huangsam · Dec 9, 2024 · 4907e35 · 4907e35
1 parent 5781d84
commit 4907e35
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/src/main/java/io/huangsam/photohaul/migration/MigratorFactory.java b/src/main/java/io/huangsam/photohaul/migration/MigratorFactory.java
@@ -21,15 +21,19 @@
 import java.security.GeneralSecurityException;
 import java.util.List;
 
+/**
+ * A factory class for creating {@link Migrator} instances based on the desired
+ * migration strategy.
+ */
 public class MigratorFactory {
     /**
      * Create instance for migrating photos.
      *
      * @param mode migrator mode
-     * @param settings application settings
-     * @param resolver photo resolver
-     * @return {@code Migrator} instance
-     * @throws MigratorException due to bad setup
+     * @param settings settings for migration process
+     * @param resolver photo resolver for target path
+     * @return migrator instance
+     * @throws MigratorException due to setup issues
      */
     public Migrator make(@NotNull MigratorMode mode, Settings settings, PhotoResolver resolver) throws MigratorException {
         return switch (mode) {