Fixed and expanded javadoc comment

This commit is contained in:
Flo0 2024-08-29 12:50:59 +02:00
parent 0fe33b71c0
commit 24546e631a

View file

@ -131,12 +131,12 @@ public interface Inventory extends Iterable<ItemStack> {
/**
* Removes ItemStacks from the inventory, based on the given filter.
* <p>
* It will try to remove 'as much as possible' each ItemStack that matches
* until the amount is reached.
* It will try to remove 'as much as possible' from each ItemStack that matches
* the filter, until the given amount is reached.
* <p>
* The returned int value specifies how many ItemStacks have been removed
* from the inventory. If the returned value is less than the amount
* passed in, then the inventory does not contain enough ItemStacks to
* passed in, then the inventory did not contain enough ItemStacks to
* satisfy the request.
*
* @param amount The amount of items to remove