[ci skip] Some javadoc fixes

This commit is contained in:
Illia Bondar 2025-04-22 14:55:41 +03:00 committed by GitHub
parent df429932ca
commit a820bdaeb9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 7 additions and 6 deletions

View File

@ -1,6 +1,7 @@
package io.papermc.paper.datacomponent.item; package io.papermc.paper.datacomponent.item;
import io.papermc.paper.datacomponent.DataComponentBuilder; import io.papermc.paper.datacomponent.DataComponentBuilder;
import io.papermc.paper.datacomponent.DataComponentTypes;
import io.papermc.paper.registry.set.RegistryKeySet; import io.papermc.paper.registry.set.RegistryKeySet;
import java.util.Collection; import java.util.Collection;
import java.util.List; import java.util.List;
@ -15,7 +16,7 @@ import org.jspecify.annotations.Nullable;
/** /**
* Controls the behavior of the item as a tool. * Controls the behavior of the item as a tool.
* @see io.papermc.paper.datacomponent.DataComponentTypes#TOOL * @see DataComponentTypes#TOOL
*/ */
@NullMarked @NullMarked
@ApiStatus.Experimental @ApiStatus.Experimental
@ -92,8 +93,6 @@ public interface Tool {
/** /**
* Overrides the mining speed if present and matched. * Overrides the mining speed if present and matched.
* <p>
* {@code true} will cause the block to mine at its most efficient speed, and drop items if the targeted block requires that.
* *
* @return speed override * @return speed override
*/ */
@ -101,6 +100,8 @@ public interface Tool {
/** /**
* Overrides whether this tool is considered 'correct' if present and matched. * Overrides whether this tool is considered 'correct' if present and matched.
* <p>
* {@code true} will cause the block to mine at its most efficient speed, and drop items if the targeted block requires that.
* *
* @return a tri-state * @return a tri-state
*/ */

View File

@ -165,7 +165,7 @@ public interface AbstractArrow extends Projectile {
* Sets the ItemStack which will be picked up from this arrow. * Sets the ItemStack which will be picked up from this arrow.
* *
* @param item ItemStack set to be picked up * @param item ItemStack set to be picked up
* @deprecated use {@link #getItemStack()} * @deprecated use {@link #setItemStack(ItemStack)}
*/ */
@ApiStatus.Experimental @ApiStatus.Experimental
@Deprecated(forRemoval = true, since = "1.20.4") // Paper @Deprecated(forRemoval = true, since = "1.20.4") // Paper

View File

@ -1048,7 +1048,7 @@ public interface Entity extends Metadatable, CommandSender, Nameable, Persistent
/** /**
* Check if entity is in water or rain * Check if entity is in water or rain
* *
* @deprecated use {@link #isInWater()}} and {@link #isInRain()} * @deprecated use {@link #isInWater()} and {@link #isInRain()}
*/ */
@Deprecated(since = "1.21.5") @Deprecated(since = "1.21.5")
default boolean isInWaterOrRain() { default boolean isInWaterOrRain() {
@ -1068,7 +1068,7 @@ public interface Entity extends Metadatable, CommandSender, Nameable, Persistent
/** /**
* Check if entity is in water or rain or bubble column * Check if entity is in water or rain or bubble column
* *
* @deprecated use {@link #isInWaterOrRain()}, bubble column is considered as water * @deprecated bubble column is considered as water, use {@link #isInWater()} and {@link #isInRain()}
*/ */
@Deprecated(since = "1.21.5") @Deprecated(since = "1.21.5")
default boolean isInWaterOrRainOrBubbleColumn() { default boolean isInWaterOrRainOrBubbleColumn() {