diff --git a/api/src/main/java/net/luckperms/api/LuckPerms.java b/api/src/main/java/net/luckperms/api/LuckPerms.java index f0fe5bc13..fa7cc2aac 100644 --- a/api/src/main/java/net/luckperms/api/LuckPerms.java +++ b/api/src/main/java/net/luckperms/api/LuckPerms.java @@ -89,7 +89,7 @@ public interface LuckPerms { * Gets the {@link UserManager}, responsible for managing * {@link User} instances. * - *

This manager can be used to retrieve instances of {@link User} by uuid + *

This manager can be used to retrieve instances of {@link User} by UUID * or name, or query all loaded users.

* * @return the user manager diff --git a/api/src/main/java/net/luckperms/api/LuckPermsProvider.java b/api/src/main/java/net/luckperms/api/LuckPermsProvider.java index 0c80b0fd4..99eeadf5b 100644 --- a/api/src/main/java/net/luckperms/api/LuckPermsProvider.java +++ b/api/src/main/java/net/luckperms/api/LuckPermsProvider.java @@ -25,6 +25,7 @@ package net.luckperms.api; +import org.jspecify.annotations.Nullable; import static org.jetbrains.annotations.ApiStatus.Internal; @@ -35,7 +36,7 @@ import static org.jetbrains.annotations.ApiStatus.Internal; * instance, however, this provider can be used if this is not viable.

*/ public final class LuckPermsProvider { - private static LuckPerms instance = null; + private static @Nullable LuckPerms instance = null; /** * Gets an instance of the {@link LuckPerms} API, diff --git a/api/src/main/java/net/luckperms/api/actionlog/ActionLog.java b/api/src/main/java/net/luckperms/api/actionlog/ActionLog.java index d96c259d1..6e27a5f1e 100644 --- a/api/src/main/java/net/luckperms/api/actionlog/ActionLog.java +++ b/api/src/main/java/net/luckperms/api/actionlog/ActionLog.java @@ -57,7 +57,7 @@ public interface ActionLog { /** * Gets the entries in the log performed by the given actor. * - * @param actor the uuid of the actor to filter by + * @param actor the UUID of the actor to filter by * @return the content for the given actor */ @Unmodifiable SortedSet getContent(UUID actor); @@ -65,8 +65,8 @@ public interface ActionLog { /** * Gets the log content for a given user * - * @param uniqueId the uuid to filter by - * @return all content in this log where the user = uuid + * @param uniqueId the UUID to filter by + * @return all content in this log where the user = UUID */ @Unmodifiable SortedSet getUserHistory(UUID uniqueId); diff --git a/api/src/main/java/net/luckperms/api/actionlog/package-info.java b/api/src/main/java/net/luckperms/api/actionlog/package-info.java index a67ce8a29..39fa55172 100644 --- a/api/src/main/java/net/luckperms/api/actionlog/package-info.java +++ b/api/src/main/java/net/luckperms/api/actionlog/package-info.java @@ -24,7 +24,7 @@ */ /** - * {@link net.luckperms.api.actionlog.ActionLog} related functionality. + * {@link net.luckperms.api.actionlog.ActionLogger} related functionality. */ @org.jspecify.annotations.NullMarked package net.luckperms.api.actionlog; \ No newline at end of file diff --git a/api/src/main/java/net/luckperms/api/cacheddata/CachedDataManager.java b/api/src/main/java/net/luckperms/api/cacheddata/CachedDataManager.java index e66626718..038f3aa2c 100644 --- a/api/src/main/java/net/luckperms/api/cacheddata/CachedDataManager.java +++ b/api/src/main/java/net/luckperms/api/cacheddata/CachedDataManager.java @@ -78,7 +78,7 @@ public interface CachedDataManager { * *

For {@link User}s, the most appropriate query options will be their * {@link ContextManager#getQueryOptions(User) current active query options} if the - * corresponding player is online, and otherwise, will fallback to + * corresponding player is online, and otherwise, will fall back to * {@link ContextManager#getStaticQueryOptions() the current static query options}.

* *

For {@link Group}s, the most appropriate query options will always be @@ -95,7 +95,7 @@ public interface CachedDataManager { * *

For {@link User}s, the most appropriate query options will be their * {@link ContextManager#getQueryOptions(User) current active query options} if the - * corresponding player is online, and otherwise, will fallback to + * corresponding player is online, and otherwise, will fall back to * {@link ContextManager#getStaticQueryOptions() the current static query options}.

* *

For {@link Group}s, the most appropriate query options will always be diff --git a/api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java b/api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java index 3a5d5a2db..64922beda 100644 --- a/api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java +++ b/api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java @@ -117,7 +117,7 @@ public interface CachedMetaData extends CachedData { * *

This method will always return a {@link Result}, but the * {@link Result#result() inner result} {@link String} will be null if - * a the resultant prefix stack contained no elements.

+ * the resultant prefix stack contained no elements.

* * @return a result containing the prefix * @since 5.4 @@ -152,7 +152,7 @@ public interface CachedMetaData extends CachedData { * *

This method will always return a {@link Result}, but the * {@link Result#result() inner result} {@link String} will be null if - * a the resultant suffix stack contained no elements.

+ * the resultant suffix stack contained no elements.

* * @return a result containing the suffix * @since 5.4 diff --git a/api/src/main/java/net/luckperms/api/context/ContextCalculator.java b/api/src/main/java/net/luckperms/api/context/ContextCalculator.java index c389d8966..b982d76b6 100644 --- a/api/src/main/java/net/luckperms/api/context/ContextCalculator.java +++ b/api/src/main/java/net/luckperms/api/context/ContextCalculator.java @@ -25,6 +25,7 @@ package net.luckperms.api.context; +import org.jspecify.annotations.Nullable; import java.util.Objects; import java.util.function.Function; @@ -37,8 +38,8 @@ import java.util.function.Function; *