Cleanup and Javadoc

Author: Ghost-chu

src/main/java/org/maxgamer/quickshop/chat/QuickChat.java

@@ -58,6 +58,14 @@ void sendItemHologramChat(
             @NotNull String text,
             @NotNull ItemStack itemStack);
 
+    /**
+     * Generate the chat component with preview item hover event
+     * @param shop The shop
+     * @param itemStack The itemstack
+     * @param player The player
+     * @param message The message with hover event
+     * @return The component
+     */
     @NotNull QuickComponent getItemHologramChat(@NotNull Shop shop, @NotNull ItemStack itemStack, @NotNull Player player, @NotNull String message);
 
     /**
@@ -85,7 +93,8 @@ void sendItemHologramChat(
      *
      * @param receiver The PLAYER will receive this message
      * @param message  The text will sent
-     * @param command  The command when click to be suggest
+     * @param command  The command when click to be suggested
+     * @param hoverText The text while player hover on the text
      */
     void sendSuggestedChat(@NotNull CommandSender receiver, @NotNull String message, @NotNull String hoverText, @NotNull String command);
 

src/main/java/org/maxgamer/quickshop/database/DatabaseTask.java

@@ -57,11 +57,23 @@ public void run(@NonNull Connection connection) {
     }
 
     interface Task {
+        /**
+         * Edit action before commit the PreparedStatement
+         * @param ps The PreparedStatement
+         * @throws SQLException Throws if any exception throws
+         */
         void edit(PreparedStatement ps) throws SQLException;
 
+        /**
+         * Calling when PreparedStatement finished without any errors
+         */
         default void onSuccess() {
         }
 
+        /**
+         * Calling when PreparedStatement failed to commit
+         * @param e The exception
+         */
         default void onFailed(SQLException e) {
             e.printStackTrace();
         }

src/main/java/org/maxgamer/quickshop/event/QSEvent.java

@@ -27,7 +27,7 @@
 
 public abstract class QSEvent extends Event {
 
-    private static final HandlerList handlers = new HandlerList();
+    private static final HandlerList HANDLERS = new HandlerList();
 
     public QSEvent() {
 
@@ -38,15 +38,18 @@ public QSEvent(boolean async) {
     }
 
     public static HandlerList getHandlerList() {
-        return handlers;
+        return HANDLERS;
     }
 
     @NotNull
     @Override
     public HandlerList getHandlers() {
-        return handlers;
+        return HANDLERS;
     }
 
+    /**
+     * Fire event on Bukkit event bus
+     */
     public void callEvent() {
         QuickShop.getInstance().getServer().getPluginManager().callEvent(this);
     }

src/main/java/org/maxgamer/quickshop/shop/Shop.java

@@ -173,6 +173,7 @@ public interface Shop {
     /**
      * Get sign texts on shop's sign.
      *
+     * @param locale The locale to be created for
      * @return String arrays represents sign texts:
      * Index | Content
      * Line 0: Header

src/main/java/org/maxgamer/quickshop/util/language/text/distributions/Distribution.java

@@ -5,11 +5,32 @@
 import java.util.List;
 
 public interface Distribution {
+    /**
+     * Gets all languages available on Distribution platform
+     * @return All available languages on Distribution platform
+     */
     @NotNull List<String> getAvailableLanguages();
-
+    /**
+     * Gets all translation files available on Distribution platform
+     * @return All translation files on Distribution platform
+     */
     @NotNull List<String> getAvailableFiles();
 
-    @NotNull String getFile(String fileCrowdinPath, String crowdinLocale) throws Exception;
-
-    @NotNull String getFile(String fileCrowdinPath, String crowdinLocale, boolean forceFlush) throws Exception;
+    /**
+     * Gets the file from the Distribution platform
+     * @param fileDistributionPath The path on the platform
+     * @param distributionLocale The locale on the platform
+     * @return The file content
+     * @throws Exception The exception throws if any errors occurred while getting file
+     */
+    @NotNull String getFile(String fileDistributionPath, String distributionLocale) throws Exception;
+    /**
+     * Gets the file from the Distribution platform
+     * @param fileDistributionPath The path on the platform
+     * @param distributionLocale The locale on the platform
+     * @param forceFlush Forces update the file from the platform
+     * @return The file content
+     * @throws Exception The exception throws if any errors occurred while getting file
+     */
+    @NotNull String getFile(String fileDistributionPath, String distributionLocale, boolean forceFlush) throws Exception;
 }

src/main/java/org/maxgamer/quickshop/util/language/text/postprocessing/PostProcessor.java

@@ -5,6 +5,13 @@
 import org.jetbrains.annotations.Nullable;
 
 public interface PostProcessor {
+    /**
+     * Process the string
+     * @param text Original string
+     * @param sender The command sender
+     * @param args The arguments
+     * @return The string that processed
+     */
     @NotNull
     String process(@NotNull String text, @Nullable CommandSender sender, String... args);
 }

src/main/java/org/maxgamer/quickshop/util/logger/ShopLogLogger.java

@@ -1,9 +1,19 @@
 package org.maxgamer.quickshop.util.mojangapi;
 
 public interface MojangApiMirror {
+    /**
+     * https://launchermeta.mojang.com
+     * @return The url root
+     */
     String getLauncherMetaRoot();
-
+    /**
+     * https://resources.download.minecraft.net
+     * @return The url root
+     */
     String getResourcesDownloadRoot();
-
+    /**
+     * https://libraries.minecraft.net
+     * @return The url root
+     */
     String getLibrariesRoot();
 }

src/main/java/org/maxgamer/quickshop/util/mojangapi/MojangApiMirror.java

@@ -25,7 +25,7 @@
 public interface Reloadable {
     /**
      * Callback for reloading
-     *
+     * @throws Exception Throws error if module failed to process reloading
      * @return Reloading success
      */
     default ReloadResult reloadModule() throws Exception {