Repo-Mirror/HMCCosmetics
9
0
Fork 0
mirror of https://github.com/HibiscusMC/HMCCosmetics.git synced 2025-12-19 15:09:19 +00:00
Code Issues Releases Activity

Merge pull request #156 from Craftinators/remapped

Browse Source 
Additional Javadoc Changes to `HMCCosmeticsAPI`
This commit is contained in:
LoJoSho
2025-01-21 23:42:19 -06:00
committed by GitHub
parent 57c2cd0719 477729242b
commit 4ad3c02d88
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
common/src/main/java/com/hibiscusmc/hmccosmetics/api/HMCCosmeticsAPI.java
View File

@@ -31,7 +31,7 @@ public final class HMCCosmeticsAPI {
* This method attempts to fetch a {@link Cosmetic} using the given id. If no {@link Cosmetic} exists * This method attempts to fetch a {@link Cosmetic} using the given id. If no {@link Cosmetic} exists
* with the specified id, it will return {@code null}. * with the specified id, it will return {@code null}.
* </p> * </p>
* @param id the id of the {@link Cosmetic} to retrieve; must not be {@code null} * @param id the id of the {@link Cosmetic} to retrieve
* @return the {@link Cosmetic} if it exists, or {@code null} if no cosmetic is associated with the given id * @return the {@link Cosmetic} if it exists, or {@code null} if no cosmetic is associated with the given id
*/ */
public static @Nullable Cosmetic getCosmetic(@NotNull String id) { public static @Nullable Cosmetic getCosmetic(@NotNull String id) {
@@ -51,7 +51,7 @@ public final class HMCCosmeticsAPI {
* </ul> * </ul>
* Always perform a {@code null} check before using the returned object to ensure safe operation. * Always perform a {@code null} check before using the returned object to ensure safe operation.
* *
* @param uuid the {@link UUID} of the player whose {@link CosmeticUser} is being retrieved; must not be {@code null} * @param uuid the {@link UUID} of the player whose {@link CosmeticUser} is being retrieved
* @return the {@link CosmeticUser} if it exists, or {@code null} if the player is offline or unassociated * @return the {@link CosmeticUser} if it exists, or {@code null} if the player is offline or unassociated
*/ */
public static @Nullable CosmeticUser getUser(@NotNull UUID uuid) { public static @Nullable CosmeticUser getUser(@NotNull UUID uuid) {
@@ -61,7 +61,7 @@ public final class HMCCosmeticsAPI {
/** /**
* Retrieves a {@link Menu} associated with the specified id, or {@code null} if no menu exists with the given id. * Retrieves a {@link Menu} associated with the specified id, or {@code null} if no menu exists with the given id.
* *
* @param id the id of the menu to retrieve; must not be {@code null} * @param id the id of the menu to retrieve
* @return the {@link Menu} if it exists, or {@code null} if no menu is associated with the given id * @return the {@link Menu} if it exists, or {@code null} if no menu is associated with the given id
*/ */
public static @Nullable Menu getMenu(@NotNull String id) { public static @Nullable Menu getMenu(@NotNull String id) {
@@ -139,7 +139,7 @@ public final class HMCCosmeticsAPI {
* </p> * </p>
* *
* @param id the id for the cosmetic slot * @param id the id for the cosmetic slot
* @return the {@link CosmeticSlot} associated with the given ID * @return the {@link CosmeticSlot} associated with the given id
*/ */
public static @NotNull CosmeticSlot registerCosmeticSlot(@NotNull String id) { public static @NotNull CosmeticSlot registerCosmeticSlot(@NotNull String id) {
return CosmeticSlot.register(id); return CosmeticSlot.register(id);