补充一点点注释

CaaMoe · May 12, 2024 · 96fde09 · 96fde09
1 parent 8db7232
commit 96fde09
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 5 deletions.
diff --git a/api/src/main/java/moe/caa/multilogin/api/MultiLoginAPI.java b/api/src/main/java/moe/caa/multilogin/api/MultiLoginAPI.java
@@ -4,16 +4,28 @@
 import moe.caa.multilogin.api.service.IService;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.Collection;
 import java.util.UUID;
 
 /**
- *
+ * 猫踢螺钉的API, 全部都在这里了
  */
 @ApiStatus.NonExtendable
 public interface MultiLoginAPI {
+
+    /**
+     * 返回所有验证服务列表
+     * @return 所有验证服务列表
+     */
     @NotNull Collection<? extends IService> getServices();
 
-    @NotNull MultiLoginPlayerData getPlayerData(@NotNull UUID inGameUUID);
+    /**
+     * 通过游戏内 uuid, 返回玩家的登录数据
+     * @param inGameUUID 游戏内uuid
+     * @return 玩家的登录数据
+     */
+    @Nullable
+    MultiLoginPlayerData getPlayerData(@NotNull UUID inGameUUID);
 }
diff --git a/api/src/main/java/moe/caa/multilogin/api/MultiLoginAPIProvider.java b/api/src/main/java/moe/caa/multilogin/api/MultiLoginAPIProvider.java
@@ -3,6 +3,9 @@
 import lombok.Getter;
 import org.jetbrains.annotations.ApiStatus;
 
+/**
+ * 提供API的地方.................................................
+ */
 @ApiStatus.NonExtendable
 public class MultiLoginAPIProvider {
     @Getter

diff --git a/api/src/main/java/moe/caa/multilogin/api/data/MultiLoginPlayerData.java b/api/src/main/java/moe/caa/multilogin/api/data/MultiLoginPlayerData.java
@@ -2,9 +2,24 @@
 
 import moe.caa.multilogin.api.profile.GameProfile;
 import moe.caa.multilogin.api.service.IService;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
 
+/**
+ * 表示一个使用猫踢螺钉登录的玩家的登录数据
+ */
+@ApiStatus.NonExtendable
 public interface MultiLoginPlayerData {
-    GameProfile getOnlineProfile();
 
-    IService getLoginService();
+    /**
+     * 获取这个玩家的在线游戏档案
+     * @return 这个玩家的在线游戏档案
+     */
+    @NotNull GameProfile getOnlineProfile();
+
+    /**
+     * 获取这个玩家使用的验证服务器
+     * @return 这个玩家使用的验证服务器
+     */
+    @NotNull IService getLoginService();
 }
diff --git a/api/src/main/java/moe/caa/multilogin/api/service/IService.java b/api/src/main/java/moe/caa/multilogin/api/service/IService.java
@@ -3,11 +3,27 @@
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * 表示一个验证服务器
+ */
 @ApiStatus.NonExtendable
 public interface IService {
+
+    /**
+     * 返回这个验证服务ID
+     * @return 这个验证服务ID
+     */
     int getServiceId();
 
+    /**
+     * 返回验证服务名字
+     * @return 验证服务名字
+     */
     @NotNull String getServiceName();
 
+    /**
+     * 返回验证服务类型
+     * @return 验证服务类型
+     */
     @NotNull ServiceType getServiceType();
 }
diff --git a/core/src/main/java/moe/caa/multilogin/core/handle/PlayerHandler.java b/core/src/main/java/moe/caa/multilogin/core/handle/PlayerHandler.java
@@ -12,6 +12,7 @@
 import moe.caa.multilogin.api.service.IService;
 import moe.caa.multilogin.core.configuration.service.BaseServiceConfig;
 import moe.caa.multilogin.core.main.MultiCore;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.Map;
 import java.util.Objects;
@@ -170,11 +171,13 @@ public static class Entry implements MultiLoginPlayerData {
         private final BaseServiceConfig serviceConfig;
         private final long signTimeMillis;
 
+        @NotNull
         @Override
         public GameProfile getOnlineProfile() {
             return onlineProfile;
         }
 
+        @NotNull
         @Override
         public IService getLoginService() {
             return serviceConfig;

diff --git a/core/src/main/java/moe/caa/multilogin/core/main/MultiCore.java b/core/src/main/java/moe/caa/multilogin/core/main/MultiCore.java
@@ -27,6 +27,7 @@
 import moe.caa.multilogin.core.semver.SemVersion;
 import moe.caa.multilogin.core.skinrestorer.SkinRestorerCore;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.io.IOException;
 import java.net.URISyntaxException;
@@ -180,7 +181,7 @@ public Collection<BaseServiceConfig> getServices() {
         return Collections.unmodifiableCollection(pluginConfig.getServiceIdMap().values());
     }
 
-    @NotNull
+    @Nullable
     @Override
     public MultiLoginPlayerData getPlayerData(@NotNull UUID inGameUUID) {
         return playerHandler.getPlayerData(inGameUUID);