From 530cdb282b0e5b0960bf530a77968ad376ff69e4 Mon Sep 17 00:00:00 2001
From: Tech <debitcardzpaypal@gmail.com>
Date: Wed, 22 Jan 2025 19:46:54 -0500
Subject: [PATCH] add further docs

---
 .../com/hibiscusmc/hmccosmetics/user/CosmeticUserProvider.java | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/common/src/main/java/com/hibiscusmc/hmccosmetics/user/CosmeticUserProvider.java b/common/src/main/java/com/hibiscusmc/hmccosmetics/user/CosmeticUserProvider.java
index 39edbad6..ac6030e9 100644
--- a/common/src/main/java/com/hibiscusmc/hmccosmetics/user/CosmeticUserProvider.java
+++ b/common/src/main/java/com/hibiscusmc/hmccosmetics/user/CosmeticUserProvider.java
@@ -2,6 +2,7 @@ package com.hibiscusmc.hmccosmetics.user;
 
 import com.hibiscusmc.hmccosmetics.HMCCosmeticsPlugin;
 import com.hibiscusmc.hmccosmetics.database.UserData;
+import org.bukkit.event.player.PlayerJoinEvent;
 import org.bukkit.plugin.Plugin;
 
 import java.util.UUID;
@@ -17,6 +18,7 @@ public interface CosmeticUserProvider {
      * @param playerId the player uuid
      * @param userData the user data associated with the player
      * @return the {@link CosmeticUser}
+     * @apiNote This method is called during the {@link PlayerJoinEvent}.
      */
     CosmeticUser createCosmeticUser(UUID playerId, UserData userData);
 
@@ -24,6 +26,7 @@ public interface CosmeticUserProvider {
      * Construct the custom {@link CosmeticUser}.
      * @param playerId the player uuid
      * @return the {@link CosmeticUser}
+     * @apiNote This method is called during the {@link PlayerJoinEvent}.
      */
     CosmeticUser createCosmeticUserWithoutData(UUID playerId);