9
0
mirror of https://github.com/HibiscusMC/HMCCosmetics.git synced 2025-12-19 15:09:19 +00:00

docs(HMCCosmeticsAPI): remove unused imports and minor javadocs changes

This commit is contained in:
Craftinators
2025-01-23 12:21:35 -05:00
parent 94cba225a6
commit 93f5bfbb2a

View File

@@ -9,10 +9,8 @@ import com.hibiscusmc.hmccosmetics.gui.Menus;
import com.hibiscusmc.hmccosmetics.user.CosmeticUser; import com.hibiscusmc.hmccosmetics.user.CosmeticUser;
import com.hibiscusmc.hmccosmetics.user.CosmeticUserProvider; import com.hibiscusmc.hmccosmetics.user.CosmeticUserProvider;
import com.hibiscusmc.hmccosmetics.user.CosmeticUsers; import com.hibiscusmc.hmccosmetics.user.CosmeticUsers;
import lombok.Getter;
import me.lojosho.hibiscuscommons.nms.NMSHandlers; import me.lojosho.hibiscuscommons.nms.NMSHandlers;
import org.bukkit.Color; import org.bukkit.Color;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
@@ -149,21 +147,21 @@ public final class HMCCosmeticsAPI {
} }
/** /**
* Registers a new cosmetic user provider to use to construct {@link CosmeticUser}s. * Registers a new cosmetic user provider to use for constructing {@link CosmeticUser} instances.
* *
* @param provider the provider to register * @param provider the provider to register
* @throws IllegalArgumentException if another plugin has already registered a provider * @throws IllegalArgumentException if another plugin has already registered a provider
*/ */
public static void registerCosmeticUserProvider(final CosmeticUserProvider provider) { public static void registerCosmeticUserProvider(@NotNull CosmeticUserProvider provider) {
CosmeticUsers.registerProvider(provider); CosmeticUsers.registerProvider(provider);
} }
/** /**
* Fetch the current {@link CosmeticUserProvider} that is in use. * Retrieves the current {@link CosmeticUserProvider} that is in use.
* *
* @return the {@link CosmeticUserProvider} * @return the current {@link CosmeticUserProvider}
*/ */
public static CosmeticUserProvider getCosmeticUserProvider() { public static @NotNull CosmeticUserProvider getCosmeticUserProvider() {
return CosmeticUsers.getProvider(); return CosmeticUsers.getProvider();
} }