From dcd02753e84a789aedb405a283b862319b9233c1 Mon Sep 17 00:00:00 2001 From: Bukkit/Spigot Date: Sun, 16 Apr 2023 09:54:51 +1000 Subject: [PATCH] #279: Minor edits to various Javadocs By: ShanerX --- paper-api/src/main/java/org/bukkit/Nameable.java | 3 +++ paper-api/src/main/java/org/bukkit/OfflinePlayer.java | 5 +++++ paper-api/src/main/java/org/bukkit/event/Cancellable.java | 3 +++ .../src/main/java/org/bukkit/plugin/java/JavaPlugin.java | 4 +++- 4 files changed, 14 insertions(+), 1 deletion(-) diff --git a/paper-api/src/main/java/org/bukkit/Nameable.java b/paper-api/src/main/java/org/bukkit/Nameable.java index fee814e01..b79daa857 100644 --- a/paper-api/src/main/java/org/bukkit/Nameable.java +++ b/paper-api/src/main/java/org/bukkit/Nameable.java @@ -2,6 +2,9 @@ package org.bukkit; import org.jetbrains.annotations.Nullable; +/** + * Represents a block, entity, or other object that may receive a custom name. + */ public interface Nameable { /** diff --git a/paper-api/src/main/java/org/bukkit/OfflinePlayer.java b/paper-api/src/main/java/org/bukkit/OfflinePlayer.java index c5eed3234..5acb0d36a 100644 --- a/paper-api/src/main/java/org/bukkit/OfflinePlayer.java +++ b/paper-api/src/main/java/org/bukkit/OfflinePlayer.java @@ -10,6 +10,11 @@ import org.bukkit.profile.PlayerProfile; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; +/** + * Represents a reference to a player identity and the data belonging to a + * player that is stored on the disk and can, thus, be retrieved without the + * player needing to be online. + */ public interface OfflinePlayer extends ServerOperator, AnimalTamer, ConfigurationSerializable { /** diff --git a/paper-api/src/main/java/org/bukkit/event/Cancellable.java b/paper-api/src/main/java/org/bukkit/event/Cancellable.java index 799b0b0f3..9e836d308 100644 --- a/paper-api/src/main/java/org/bukkit/event/Cancellable.java +++ b/paper-api/src/main/java/org/bukkit/event/Cancellable.java @@ -1,5 +1,8 @@ package org.bukkit.event; +/** + * A type characterizing events that may be cancelled by a plugin or the server. + */ public interface Cancellable { /** diff --git a/paper-api/src/main/java/org/bukkit/plugin/java/JavaPlugin.java b/paper-api/src/main/java/org/bukkit/plugin/java/JavaPlugin.java index 669a70faa..ee100b7ad 100644 --- a/paper-api/src/main/java/org/bukkit/plugin/java/JavaPlugin.java +++ b/paper-api/src/main/java/org/bukkit/plugin/java/JavaPlugin.java @@ -30,7 +30,9 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; /** - * Represents a Java plugin + * Represents a Java plugin and its main class. It contains fundamental methods + * and fields for a plugin to be loaded and work properly. This is an indirect + * implementation of {@link org.bukkit.plugin.Plugin}. */ public abstract class JavaPlugin extends PluginBase { private boolean isEnabled = false;