Javadoc improvements per checkstyle

By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot
2019-12-22 09:56:28 +11:00
parent d419ccca3f
commit d16413b877
96 changed files with 181 additions and 48 deletions

View File

@@ -32,7 +32,6 @@ public class BlockCanBuildEvent extends BlockEvent {
}
/**
*
* @param block the block involved in this event
* @param player the player placing the block
* @param type the id of the block to place

View File

@@ -0,0 +1,7 @@
/**
* {@link org.bukkit.event.Event Events} relating to when a {@link
* org.bukkit.block.Block block} is changed or interacts with the {@link
* org.bukkit.World world}.
*/
package org.bukkit.event.block;

View File

@@ -0,0 +1,6 @@
/**
* {@link org.bukkit.event.Event Events} triggered from an {@link
* org.bukkit.inventory.EnchantingInventory enchantment table}.
*/
package org.bukkit.event.enchantment;

View File

@@ -77,11 +77,11 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
*
* @param type the damage modifier
* @param damage the scalar value of the damage's modifier
* @see #getFinalDamage()
* @throws IllegalArgumentException if type is null
* @throws UnsupportedOperationException if the caller does not support
* the particular DamageModifier, or to rephrase, when {@link
* #isApplicable(DamageModifier)} returns false
* @see #getFinalDamage()
*/
public void setDamage(@NotNull DamageModifier type, double damage) throws IllegalArgumentException, UnsupportedOperationException {
if (!modifiers.containsKey(type)) {

View File

@@ -58,8 +58,8 @@ public class VillagerReplenishTradeEvent extends EntityEvent implements Cancella
/**
* Set the bonus uses added.
*
* @see VillagerReplenishTradeEvent#getBonus()
* @param bonus the extra uses added
* @see VillagerReplenishTradeEvent#getBonus()
*/
public void setBonus(int bonus) {
this.bonus = bonus;

View File

@@ -0,0 +1,7 @@
/**
* {@link org.bukkit.event.Event Events} relating to {@link
* org.bukkit.entity.Entity entities}, excluding some directly referencing
* some more specific entity types.
*/
package org.bukkit.event.entity;

View File

@@ -0,0 +1,6 @@
/**
* {@link org.bukkit.event.Event Events} relating to {@link
* org.bukkit.entity.Hanging entities that hang}.
*/
package org.bukkit.event.hanging;

View File

@@ -30,8 +30,8 @@ public abstract class InventoryInteractEvent extends InventoryEvent implements C
* Sets the result of this event. This will change whether or not this
* event is considered cancelled.
*
* @see #isCancelled()
* @param newResult the new {@link org.bukkit.event.Event.Result} for this event
* @see #isCancelled()
*/
public void setResult(@NotNull Result newResult) {
result = newResult;

View File

@@ -0,0 +1,6 @@
/**
* {@link org.bukkit.event.Event Events} relating to {@link
* org.bukkit.inventory.Inventory inventory} manipulation.
*/
package org.bukkit.event.inventory;

View File

@@ -0,0 +1,5 @@
/**
* Classes dedicated to handling triggered code executions.
*/
package org.bukkit.event;

View File

@@ -31,7 +31,6 @@ public class AsyncPlayerChatEvent extends PlayerEvent implements Cancellable {
private final Set<Player> recipients;
/**
*
* @param async This changes the event to a synchronous state.
* @param who the chat sender
* @param message the message sent

View File

@@ -0,0 +1,6 @@
/**
* {@link org.bukkit.event.Event Events} relating to {@link
* org.bukkit.entity.Player players}.
*/
package org.bukkit.event.player;

View File

@@ -0,0 +1,4 @@
/**
* Events related to raids.
*/
package org.bukkit.event.raid;

View File

@@ -0,0 +1,6 @@
/**
* {@link org.bukkit.event.Event Events} relating to programmatic state
* changes on the server.
*/
package org.bukkit.event.server;

View File

@@ -0,0 +1,6 @@
/**
* {@link org.bukkit.event.Event Events} relating to {@link
* org.bukkit.entity.Vehicle vehicular entities}.
*/
package org.bukkit.event.vehicle;

View File

@@ -0,0 +1,5 @@
/**
* {@link org.bukkit.event.Event Events} relating to weather.
*/
package org.bukkit.event.weather;

View File

@@ -0,0 +1,6 @@
/**
* {@link org.bukkit.event.Event Events} triggered by various {@link
* org.bukkit.World world} states or changes.
*/
package org.bukkit.event.world;