From 42dd11507591493baf4b58cd0e97a5242d98d2fa Mon Sep 17 00:00:00 2001
From: 502647092 <admin@yumc.pw>
Date: Mon, 19 Sep 2016 15:19:59 +0800
Subject: [PATCH] =?UTF-8?q?doc:=20=E5=AE=8C=E5=96=84javadoc?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: 502647092 <admin@yumc.pw>
---
 src/main/java/pw/yumc/YumCore/bukkit/Log.java | 14 +++++++++-----
 src/main/java/pw/yumc/YumCore/bukkit/P.java   |  6 ++++++
 .../pw/yumc/YumCore/bukkit/compatible/C.java  |  6 ++++++
 .../pw/yumc/YumCore/commands/CommandHelp.java | 12 +++++++++---
 .../yumc/YumCore/commands/CommandManager.java |  2 +-
 .../YumCore/config/AbstractInjectConfig.java  |  9 +++++----
 .../pw/yumc/YumCore/config/FileConfig.java    | 19 +++++++++++++++----
 .../config/InjectConfigurationSection.java    |  3 +++
 .../pw/yumc/YumCore/config/PlayerConfig.java  | 12 ++++++------
 .../pw/yumc/YumCore/config/YumConfig.java     | 11 ++++++-----
 .../pw/yumc/YumCore/statistic/Statistics.java |  3 ---
 .../pw/yumc/YumCore/tellraw/MessagePart.java  |  2 +-
 .../java/pw/yumc/YumCore/tellraw/Tellraw.java |  8 ++++----
 .../pw/yumc/YumCore/update/SubscribeTask.java | 18 ++++++++++++++++--
 14 files changed, 87 insertions(+), 38 deletions(-)

diff --git a/src/main/java/pw/yumc/YumCore/bukkit/Log.java b/src/main/java/pw/yumc/YumCore/bukkit/Log.java
index 7766827..8e860cf 100644
--- a/src/main/java/pw/yumc/YumCore/bukkit/Log.java
+++ b/src/main/java/pw/yumc/YumCore/bukkit/Log.java
@@ -55,18 +55,20 @@ public class Log {
      * @param message
      *            Message to be displayed
      */
-    public static void console(final String msg) {
-        console.sendMessage(prefix + msg);
+    public static void console(final String message) {
+        console.sendMessage(prefix + message);
     }
 
     /**
      * Sends console a message
      *
      * @param message
-     *            Message to be displayed
+     *            消息
+     * @param object
+     *            格式化参数
      */
-    public static void console(final String msg, final Object... object) {
-        console.sendMessage(prefix + String.format(msg, object));
+    public static void console(final String message, final Object... object) {
+        console.sendMessage(prefix + String.format(message, object));
     }
 
     /**
@@ -112,6 +114,8 @@ public class Log {
      *
      * @param msg
      *            消息
+     * @param e
+     *            异常
      */
     public static void debug(final String msg, final Throwable e) {
         if (debug) {
diff --git a/src/main/java/pw/yumc/YumCore/bukkit/P.java b/src/main/java/pw/yumc/YumCore/bukkit/P.java
index a927cd5..3a8e7ec 100644
--- a/src/main/java/pw/yumc/YumCore/bukkit/P.java
+++ b/src/main/java/pw/yumc/YumCore/bukkit/P.java
@@ -8,6 +8,8 @@ import org.bukkit.command.PluginCommand;
 import org.bukkit.plugin.PluginDescriptionFile;
 import org.bukkit.plugin.java.JavaPlugin;
 
+import pw.yumc.YumCore.config.FileConfig;
+
 /**
  * 插件Instance获取类
  *
@@ -42,6 +44,8 @@ public class P {
     }
 
     /**
+     * @param FC
+     *            {@link FileConfig}
      * @return 获得插件配置文件
      */
     @SuppressWarnings("unchecked")
@@ -78,6 +82,8 @@ public class P {
     }
 
     /**
+     * @param PI
+     *            插件主类
      * @return 获得插件
      */
     @SuppressWarnings("unchecked")
diff --git a/src/main/java/pw/yumc/YumCore/bukkit/compatible/C.java b/src/main/java/pw/yumc/YumCore/bukkit/compatible/C.java
index 9b72b1a..5cac378 100644
--- a/src/main/java/pw/yumc/YumCore/bukkit/compatible/C.java
+++ b/src/main/java/pw/yumc/YumCore/bukkit/compatible/C.java
@@ -302,6 +302,12 @@ public class C {
          *            标题
          * @param subtitle
          *            子标题
+         * @param fadeInTime
+         *            淡入时间
+         * @param stayTime
+         *            持续时间
+         * @param fadeOutTime
+         *            淡出时间
          */
         public static void broadcast(final String title, final String subtitle, final int fadeInTime, final int stayTime, final int fadeOutTime) {
             for (final org.bukkit.entity.Player player : Player.getOnlinePlayers()) {
diff --git a/src/main/java/pw/yumc/YumCore/commands/CommandHelp.java b/src/main/java/pw/yumc/YumCore/commands/CommandHelp.java
index e80c552..3db41d8 100644
--- a/src/main/java/pw/yumc/YumCore/commands/CommandHelp.java
+++ b/src/main/java/pw/yumc/YumCore/commands/CommandHelp.java
@@ -114,8 +114,14 @@ public class CommandHelp {
     /**
      * 发送帮助
      *
-     * @param ca
-     *            命令参数
+     * @param sender
+     *            命令发送者
+     * @param command
+     *            命令
+     * @param label
+     *            标签
+     * @param args
+     *            参数
      */
     public void send(final CommandSender sender, final Command command, final String label, final String[] args) {
         if (this.HELPPAGECOUNT == 0) {
@@ -158,7 +164,7 @@ public class CommandHelp {
 
     /**
      * 设置解析器
-     * 
+     *
      * @param helpParse
      *            帮助解析器
      */
diff --git a/src/main/java/pw/yumc/YumCore/commands/CommandManager.java b/src/main/java/pw/yumc/YumCore/commands/CommandManager.java
index c199d52..1fb7065 100644
--- a/src/main/java/pw/yumc/YumCore/commands/CommandManager.java
+++ b/src/main/java/pw/yumc/YumCore/commands/CommandManager.java
@@ -130,7 +130,7 @@ public class CommandManager implements TabExecutor {
     /**
      * 通过注解读取命令并注册
      *
-     * @param clazz
+     * @param clazzs
      *            子命令处理类
      */
     public void register(final CommandExecutor... clazzs) {
diff --git a/src/main/java/pw/yumc/YumCore/config/AbstractInjectConfig.java b/src/main/java/pw/yumc/YumCore/config/AbstractInjectConfig.java
index 83ad5f0..1878b7d 100644
--- a/src/main/java/pw/yumc/YumCore/config/AbstractInjectConfig.java
+++ b/src/main/java/pw/yumc/YumCore/config/AbstractInjectConfig.java
@@ -11,6 +11,7 @@ import org.bukkit.configuration.ConfigurationSection;
 import pw.yumc.YumCore.bukkit.Log;
 
 /**
+ * 抽象注入配置
  *
  * @since 2016年7月5日 上午10:11:22
  * @author 喵♂呜
@@ -26,6 +27,9 @@ public abstract class AbstractInjectConfig {
 
     /**
      * 注入配置数据
+     *
+     * @param config
+     *            配置区
      */
     public void inject(final ConfigurationSection config) {
         if (config == null) {
@@ -49,7 +53,7 @@ public abstract class AbstractInjectConfig {
 
     /**
      * 转换字段值类型
-     * 
+     *
      * @param type
      *            字段类型
      * @param path
@@ -138,9 +142,6 @@ public abstract class AbstractInjectConfig {
      *            配置路径
      * @param field
      *            字段
-     * @return 是否解析成功
-     * @throws IllegalArgumentException
-     * @throws IllegalAccessException
      */
     protected void setField(final String path, final Field field) {
         Object value = config.get(path);
diff --git a/src/main/java/pw/yumc/YumCore/config/FileConfig.java b/src/main/java/pw/yumc/YumCore/config/FileConfig.java
index 533c1ec..a182192 100644
--- a/src/main/java/pw/yumc/YumCore/config/FileConfig.java
+++ b/src/main/java/pw/yumc/YumCore/config/FileConfig.java
@@ -159,6 +159,8 @@ public class FileConfig extends AbstractConfig {
      *            路径
      * @param obj
      *            字符串
+     * @param allowrepeat
+     *            是否允许重复
      * @return {@link FileConfig}
      */
     public FileConfig addToStringList(final String path, final String obj, final boolean allowrepeat) {
@@ -214,7 +216,7 @@ public class FileConfig extends AbstractConfig {
     /**
      * 获得Location
      *
-     * @param key
+     * @param path
      *            键
      * @param def
      *            默认地点
@@ -297,8 +299,10 @@ public class FileConfig extends AbstractConfig {
     /**
      * 比较版本号
      *
-     * @param 新版本
-     * @param 旧版本
+     * @param newver
+     *            新版本
+     * @param oldver
+     *            旧版本
      * @return 是否需要更新
      */
     public boolean needUpdate(final String newver, final String oldver) {
@@ -428,6 +432,12 @@ public class FileConfig extends AbstractConfig {
         }
     }
 
+    /**
+     * 备份配置文件
+     *
+     * @param oldcfg
+     *            配置文件
+     */
     protected void backupConfig(final FileConfig oldcfg) {
         final String filename = oldcfg.getConfigName();
         try {
@@ -510,6 +520,8 @@ public class FileConfig extends AbstractConfig {
      *
      * @param file
      *            配置文件
+     * @param check
+     *            是否检查文件
      * @return FileConfig
      */
     protected FileConfig init(final File file, final boolean check) {
@@ -573,7 +585,6 @@ public class FileConfig extends AbstractConfig {
      *            新配置文件
      * @param oldcfg
      *            旧配置文件
-     *
      * @return 更新以后的配置文件
      */
     protected FileConfig updateConfig(final FileConfig newCfg, final FileConfig oldCfg) {
diff --git a/src/main/java/pw/yumc/YumCore/config/InjectConfigurationSection.java b/src/main/java/pw/yumc/YumCore/config/InjectConfigurationSection.java
index 82b2d2d..919ec63 100644
--- a/src/main/java/pw/yumc/YumCore/config/InjectConfigurationSection.java
+++ b/src/main/java/pw/yumc/YumCore/config/InjectConfigurationSection.java
@@ -16,6 +16,9 @@ public abstract class InjectConfigurationSection extends AbstractInjectConfig {
 
     /**
      * 重载配置文件
+     *
+     * @param config
+     *            配置区
      */
     public void reload(final ConfigurationSection config) {
         inject(config);
diff --git a/src/main/java/pw/yumc/YumCore/config/PlayerConfig.java b/src/main/java/pw/yumc/YumCore/config/PlayerConfig.java
index 0b2a3bb..3c61c9f 100644
--- a/src/main/java/pw/yumc/YumCore/config/PlayerConfig.java
+++ b/src/main/java/pw/yumc/YumCore/config/PlayerConfig.java
@@ -16,8 +16,8 @@ public class PlayerConfig extends FileConfig {
     /**
      * 获得玩家配置(保存在 指定 文件夹)
      *
-     * @param 指定目录
-     *            插件
+     * @param dir
+     *            指定目录
      * @param player
      *            玩家
      */
@@ -28,8 +28,8 @@ public class PlayerConfig extends FileConfig {
     /**
      * 获得玩家配置(保存在 CONFIG_FOLDER 文件夹)
      *
-     * @param playername
-     *            玩家名称
+     * @param player
+     *            玩家
      */
     public PlayerConfig(final Player player) {
         this(player.getName());
@@ -38,8 +38,8 @@ public class PlayerConfig extends FileConfig {
     /**
      * 获得玩家配置(保存在 CONFIG_FOLDER 文件夹)
      *
-     * @param player
-     *            玩家
+     * @param playername
+     *            玩家名称
      */
     public PlayerConfig(final String playername) {
         super(new File(plugin.getDataFolder(), CONFIG_FOLDER), playername + ".yml");
diff --git a/src/main/java/pw/yumc/YumCore/config/YumConfig.java b/src/main/java/pw/yumc/YumCore/config/YumConfig.java
index 3f4f0c5..c302206 100644
--- a/src/main/java/pw/yumc/YumCore/config/YumConfig.java
+++ b/src/main/java/pw/yumc/YumCore/config/YumConfig.java
@@ -15,8 +15,8 @@ public class YumConfig {
     /**
      * 获得本地配置文件
      *
-     * @param url
-     *            配置文件地址
+     * @param filename
+     *            本地文件名称
      * @return {@link FileConfig}
      */
     public static FileConfig getLocal(final String filename) {
@@ -31,13 +31,14 @@ public class YumConfig {
      *            配置文件地址
      * @return {@link FileConfig}
      */
-    public static FileConfig getRemote(final String filename) {
+    public static FileConfig getRemote(final String url) {
         FileConfig config = null;
         try {
-            config = new RemoteConfig(REMOTEFILECENTER + filename);
+            config = new RemoteConfig(REMOTEFILECENTER + url);
         } catch (final IOException e) {
+            Log.debug(e);
         }
-        Log.info(String.format(config == null ? createError : fromYumc, filename));
+        Log.info(String.format(config == null ? createError : fromYumc, url));
         return config;
     }
 }
diff --git a/src/main/java/pw/yumc/YumCore/statistic/Statistics.java b/src/main/java/pw/yumc/YumCore/statistic/Statistics.java
index 6204b94..606d398 100644
--- a/src/main/java/pw/yumc/YumCore/statistic/Statistics.java
+++ b/src/main/java/pw/yumc/YumCore/statistic/Statistics.java
@@ -106,9 +106,6 @@ public class Statistics {
 
     /**
      * 插件使用数据统计
-     *
-     * @throws IOException
-     *             IO异常
      */
     public Statistics() {
         try {
diff --git a/src/main/java/pw/yumc/YumCore/tellraw/MessagePart.java b/src/main/java/pw/yumc/YumCore/tellraw/MessagePart.java
index bdce4fc..a11f859 100644
--- a/src/main/java/pw/yumc/YumCore/tellraw/MessagePart.java
+++ b/src/main/java/pw/yumc/YumCore/tellraw/MessagePart.java
@@ -45,7 +45,7 @@ public class MessagePart {
     }
 
     /**
-     * 是否有文本
+     * @return 是否有文本
      */
     public boolean hasText() {
         return text != null && !text.isEmpty();
diff --git a/src/main/java/pw/yumc/YumCore/tellraw/Tellraw.java b/src/main/java/pw/yumc/YumCore/tellraw/Tellraw.java
index 3c97e11..0abf888 100644
--- a/src/main/java/pw/yumc/YumCore/tellraw/Tellraw.java
+++ b/src/main/java/pw/yumc/YumCore/tellraw/Tellraw.java
@@ -227,8 +227,8 @@ public class Tellraw {
     /**
      * 悬浮消息
      *
-     * @param text
-     *            文本
+     * @param texts
+     *            文本列
      * @return {@link Tellraw}
      */
     public Tellraw tip(final List<String> texts) {
@@ -256,8 +256,8 @@ public class Tellraw {
     /**
      * 悬浮消息
      *
-     * @param text
-     *            文本
+     * @param texts
+     *            文本列
      * @return {@link Tellraw}
      */
     public Tellraw tip(final String... texts) {
diff --git a/src/main/java/pw/yumc/YumCore/update/SubscribeTask.java b/src/main/java/pw/yumc/YumCore/update/SubscribeTask.java
index cb01b4d..ccfa113 100644
--- a/src/main/java/pw/yumc/YumCore/update/SubscribeTask.java
+++ b/src/main/java/pw/yumc/YumCore/update/SubscribeTask.java
@@ -92,6 +92,9 @@ public class SubscribeTask implements Runnable {
 
     /**
      * 自动更新
+     *
+     * @param isMaven
+     *            是否为Maven
      */
     public SubscribeTask(final boolean isMaven) {
         this(false, isMaven);
@@ -99,6 +102,11 @@ public class SubscribeTask implements Runnable {
 
     /**
      * 自动更新
+     *
+     * @param isSecret
+     *            是否为私有
+     * @param isMaven
+     *            是否为Maven
      */
     public SubscribeTask(final boolean isSecret, final boolean isMaven) {
         this("master", isSecret, isMaven);
@@ -109,6 +117,10 @@ public class SubscribeTask implements Runnable {
      *
      * @param branch
      *            更新分支
+     * @param isSecret
+     *            是否为私有
+     * @param isMaven
+     *            是否为Maven
      */
     public SubscribeTask(final String branch, final boolean isSecret, final boolean isMaven) {
         this.branch = branch;
@@ -179,8 +191,10 @@ public class SubscribeTask implements Runnable {
     /**
      * 比较版本号
      *
-     * @param 新版本
-     * @param 旧版本
+     * @param v1
+     *            新版本
+     * @param v2
+     *            旧版本
      * @return 是否需要更新
      */
     public boolean needUpdate(final String v1, final String v2) {