#831: Add a standard of annotations for Minecraft experimental things and API

By: Doc <nachito94@msn.com>
Also-by: 2008Choco <hawkeboyz2@hotmail.com>
This commit is contained in:
Bukkit/Spigot
2023-04-07 09:41:58 +10:00
parent 0bf4318605
commit bec81a9aff
40 changed files with 559 additions and 36 deletions

View File

@@ -1,10 +1,10 @@
package org.bukkit.event.block;
import org.bukkit.Warning;
import org.bukkit.block.Block;
import org.bukkit.event.HandlerList;
import org.bukkit.event.inventory.FurnaceStartSmeltEvent;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
/**
@@ -15,10 +15,9 @@ import org.jetbrains.annotations.NotNull;
* <li>A Campfire starts cooking {@link CampfireStartEvent}</li>
* </ul>
*
* @deprecated draft API
* @apiNote draft API
*/
@Deprecated
@Warning(false)
@ApiStatus.Experimental
public class InventoryBlockStartEvent extends BlockEvent {
private static final HandlerList handlers = new HandlerList();

View File

@@ -1,5 +1,6 @@
package org.bukkit.event.inventory;
import org.bukkit.MinecraftExperimental;
import org.bukkit.inventory.InventoryHolder;
import org.jetbrains.annotations.NotNull;
@@ -145,9 +146,9 @@ public enum InventoryType {
/**
* The new smithing inventory, with 3 CRAFTING slots and 1 RESULT slot.
*
* @deprecated draft, experimental 1.20 API
* @apiNote draft, experimental 1.20 API
*/
@Deprecated
@MinecraftExperimental
SMITHING_NEW(4, "Upgrade Gear"),
;

View File

@@ -1,24 +1,23 @@
package org.bukkit.event.player;
import org.bukkit.Warning;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
/**
* Called when a visible entity is hidden from a player.
*
* <br>
* This event is only called when the entity's visibility status is actually
* changed.
*
* <br>
* This event is called regardless of if the entity was within tracking range.
*
* @see Player#hideEntity(org.bukkit.plugin.Plugin, org.bukkit.entity.Entity)
* @deprecated draft API
* @apiNote draft API
*/
@Deprecated
@Warning(false)
@ApiStatus.Experimental
public class PlayerHideEntityEvent extends PlayerEvent {
private static final HandlerList handlers = new HandlerList();

View File

@@ -1,25 +1,24 @@
package org.bukkit.event.player;
import org.bukkit.Warning;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
/**
* Called when a hidden entity is shown to a player.
*
* <br>
* This event is only called when the entity's visibility status is actually
* changed.
*
* <br>
* This event is called regardless of whether the entity was within tracking
* range.
*
* @see Player#showEntity(org.bukkit.plugin.Plugin, org.bukkit.entity.Entity)
* @deprecated draft API
* @apiNote draft API
*/
@Deprecated
@Warning(false)
@ApiStatus.Experimental
public class PlayerShowEntityEvent extends PlayerEvent {
private static final HandlerList handlers = new HandlerList();