#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
@@ -2,6 +2,7 @@ package org.bukkit.entity;
import java.util.Collection;
import org.bukkit.Location;
import org.bukkit.MinecraftExperimental;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -9,15 +10,16 @@ import org.jetbrains.annotations.Nullable;
/**
* Represents a Sniffer.
*
* <b>Note: This entity is part of an experimental feature of Minecraft and
* hence subject to change.</b>
* @apiNote This entity is part of an experimental feature of Minecraft and
* hence subject to change.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface Sniffer extends Animals {
/**
* Gets the locations explored by the sniffer.
*
* <br>
* <b>Note:</b> the returned locations use sniffer's current world.
*
* @return a collection of locations
@@ -27,11 +29,10 @@ public interface Sniffer extends Animals {
/**
* Remove a location of the explored locations.
*
* <br>
* <b>Note:</b> the location must be in the sniffer's current world for this
* method to have any effect.
*
*
* @param location the location to remove
* @see #getExploredLocations()
*/
@@ -39,11 +40,10 @@ public interface Sniffer extends Animals {
/**
* Add a location to the explored locations.
*
* <br>
* <b>Note:</b> the location must be in the sniffer's current world for this
* method to have any effect.
*
*
* @param location the location to add
* @see #getExploredLocations()
*/