Updated Javadocs for method clarity

Enhanced documentation across `EconomyController` and `CurrencyHolder`. Clarified behaviors, improved annotations, and ensured consistent descriptions for return values and exceptions.

Author: NonSwag

src/main/java/net/thenextlvl/service/api/economy/EconomyController.java

@@ -182,10 +182,11 @@ default CompletableFuture<Optional<Account>> tryGetAccount(UUID uuid, @Nullable
 
     /**
      * Creates an account for the specified player.
+     * <p>
+     * Completes with an {@link IllegalStateException} if a similar account already exists
      *
      * @param player the player for whom the account will be created
      * @return a CompletableFuture that will complete with the created account
-     * @throws IllegalStateException if a similar account already exists
      */
     @Contract("_ -> new")
     default CompletableFuture<Account> createAccount(OfflinePlayer player) {
@@ -194,6 +195,8 @@ default CompletableFuture<Account> createAccount(OfflinePlayer player) {
 
     /**
      * Creates an account for the specified player in the specified world.
+     * <p>
+     * Completes with an {@link IllegalStateException} if a similar account already exists
      *
      * @param player the player for whom the account will be created
      * @param world  the world in which the player's account will be created
@@ -206,6 +209,8 @@ default CompletableFuture<Account> createAccount(OfflinePlayer player, @Nullable
 
     /**
      * Creates an account with the given uuid.
+     * <p>
+     * Completes with an {@link IllegalStateException} if a similar account already exists
      *
      * @param uuid the uuid of the account to be created
      * @return a CompletableFuture that will complete with the created account
@@ -217,6 +222,8 @@ default CompletableFuture<Account> createAccount(UUID uuid) {
 
     /**
      * Creates an account with the given uuid and world.
+     * <p>
+     * Completes with an {@link IllegalStateException} if a similar account already exists
      *
      * @param uuid  the uuid of the account to be created
      * @param world the world in which the account will be created
@@ -269,49 +276,49 @@ default CompletableFuture<Optional<Account>> loadAccount(UUID uuid) {
      * Deletes the specified account.
      *
      * @param account the account to be deleted
-     * @return a CompletableFuture that will complete when the account is deleted
+     * @return a {@code CompletableFuture} completing with a boolean indicating whether the account was deleted
      */
     default CompletableFuture<Boolean> deleteAccount(Account account) {
         return deleteAccount(account.getOwner(), account.getWorld().orElse(null));
     }
 
     /**
-     * Deletes the account of the specified player.
+     * Deletes the account of the given player.
      *
      * @param player the player whose account will be deleted
-     * @return a CompletableFuture that will complete when the account is deleted
+     * @return a {@code CompletableFuture} completing with a boolean indicating whether the account was deleted
      */
     default CompletableFuture<Boolean> deleteAccount(OfflinePlayer player) {
         return deleteAccount(player, null);
     }
 
     /**
-     * Deletes the account of the specified player in the specified world.
+     * Deletes the account of the given player in the specified world.
      *
      * @param player the player whose account will be deleted
      * @param world  the world in which the player's account exists
-     * @return a CompletableFuture that will complete when the account is deleted
+     * @return a {@code CompletableFuture} completing with a boolean indicating whether the account was deleted
      */
     default CompletableFuture<Boolean> deleteAccount(OfflinePlayer player, @Nullable World world) {
         return deleteAccount(player.getUniqueId(), world);
     }
 
     /**
-     * Deletes the account with the specified uuid.
+     * Deletes the account of the given owner's UUID.
      *
      * @param uuid the uuid of the account to be deleted
-     * @return a CompletableFuture that will complete when the account is deleted
+     * @return a {@code CompletableFuture} completing with a boolean indicating whether the account was deleted
      */
     default CompletableFuture<Boolean> deleteAccount(UUID uuid) {
         return deleteAccount(uuid, null);
     }
 
     /**
-     * Deletes the account with the specified uuid in the specified world.
+     * Deletes the account of the given owner's uuid in the specified world.
      *
      * @param uuid  the uuid of the account to be deleted
      * @param world the world in which the account exists
-     * @return a CompletableFuture that will complete when the account is deleted
+     * @return a {@code CompletableFuture} completing with a boolean indicating whether the account was deleted
      */
     CompletableFuture<Boolean> deleteAccount(UUID uuid, @Nullable World world);
 

src/main/java/net/thenextlvl/service/api/economy/currency/CurrencyHolder.java

@@ -39,7 +39,8 @@ default int fractionalDigits() {
     }
 
     /**
-     * Retrieves all currencies managed by the currency holder.
+     * Retrieves all currencies managed by the currency holder,
+     * including the {@link #getDefaultCurrency() default currency}.
      *
      * @return an unmodifiable set of currencies
      * @throws UnsupportedOperationException if {@link #hasMultiCurrencySupport()} is {@code false}
@@ -111,7 +112,7 @@ default boolean deleteCurrency(String name) {
     Currency getDefaultCurrency();
 
     /**
-     * Determines whether the economy controller supports multiple currencies.
+     * Determines whether the holder supports multiple currencies.
      *
      * @return {@code true} if multi-currency is supported, otherwise {@code false}
      * @implSpec If multiple currencies are supported, all respective methods have to be implemented.