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

@@ -1,6 +0,0 @@
/**
* Classes used to manipulate the voxels in a {@link org.bukkit.World world},
* including special states.
*/
package org.bukkit.block;

View File

@@ -1,6 +0,0 @@
/**
* Commands for emulating the Minecraft commands and other necessary ones for
* use by a Bukkit implementation.
*/
package org.bukkit.command.defaults;

View File

@@ -1,5 +0,0 @@
/**
* Classes relating to handling specialized non-chat player input.
*/
package org.bukkit.command;

View File

@@ -1,7 +0,0 @@
/**
* Classes dedicated facilitating {@link
* org.bukkit.configuration.Configuration configurations} to be read and
* stored on the filesystem.
*/
package org.bukkit.configuration.file;

View File

@@ -1,5 +0,0 @@
/**
* Classes dedicated to handling a plugin's runtime configuration.
*/
package org.bukkit.configuration;

View File

@@ -1,7 +0,0 @@
/**
* Classes dedicated to being able to perform serialization specialized for
* the Bukkit {@link org.bukkit.configuration.Configuration configuration}
* implementation.
*/
package org.bukkit.configuration.serialization;

View File

@@ -1,5 +0,0 @@
/**
* Classes dedicated to facilitate direct player-to-plugin communication.
*/
package org.bukkit.conversations;

View File

@@ -1,7 +0,0 @@
/**
* Classes relating to the specialized enhancements to {@link
* org.bukkit.inventory.ItemStack item stacks}, as part of the {@link
* org.bukkit.inventory.meta.ItemMeta meta data}.
*/
package org.bukkit.enchantments;

View File

@@ -1,5 +0,0 @@
/**
* Interfaces for various {@link org.bukkit.entity.Minecart} types.
*/
package org.bukkit.entity.minecart;

View File

@@ -1,6 +0,0 @@
/**
* Interfaces for non-voxel objects that can exist in a {@link
* org.bukkit.World world}, including all players, monsters, projectiles, etc.
*/
package org.bukkit.entity;

View File

@@ -1,7 +0,0 @@
/**
* {@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

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

View File

@@ -1,7 +0,0 @@
/**
* {@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

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,6 +0,0 @@
/**
* Classes to facilitate {@link org.bukkit.World world} generation
* implementation.
*/
package org.bukkit.generator;

View File

@@ -1,5 +0,0 @@
/**
* Classes used to manipulate the default command and topic assistance system.
*/
package org.bukkit.help;

View File

@@ -1,6 +0,0 @@
/**
* The interfaces used when manipulating extra data can can be stored inside
* {@link org.bukkit.inventory.ItemStack item stacks}.
*/
package org.bukkit.inventory.meta;

View File

@@ -1,5 +0,0 @@
/**
* Classes involved in manipulating player inventories and item interactions.
*/
package org.bukkit.inventory;

View File

@@ -1,6 +0,0 @@
/**
* Classes to facilitate plugin handling of {@link org.bukkit.Material#MAP
* map} displays.
*/
package org.bukkit.map;

View File

@@ -1,5 +0,0 @@
/**
* Classes that represents various voxel types and states.
*/
package org.bukkit.material;

View File

@@ -1,6 +0,0 @@
/**
* Classes dedicated to providing a layer of plugin specified data on various
* Minecraft concepts.
*/
package org.bukkit.metadata;

View File

@@ -1,5 +0,0 @@
/**
* More generalized classes in the API.
*/
package org.bukkit;

View File

@@ -1,5 +0,0 @@
/**
* Classes dedicated to providing binary state properties to players.
*/
package org.bukkit.permissions;

View File

@@ -1,6 +0,0 @@
/**
* Classes for handling {@link org.bukkit.plugin.Plugin plugins} written in
* java.
*/
package org.bukkit.plugin.java;

View File

@@ -1,5 +0,0 @@
/**
* Classes dedicated to specialized plugin to client protocols.
*/
package org.bukkit.plugin.messaging;

View File

@@ -1,5 +0,0 @@
/**
* Classes specifically relating to loading software modules at runtime.
*/
package org.bukkit.plugin;

View File

@@ -1,6 +0,0 @@
/**
* Classes to represent various {@link org.bukkit.Material#POTION potion}
* properties and manipulation.
*/
package org.bukkit.potion;

View File

@@ -1,5 +0,0 @@
/**
* Classes to represent the source of a projectile
*/
package org.bukkit.projectiles;

View File

@@ -1,6 +0,0 @@
/**
* Classes dedicated to letting {@link org.bukkit.plugin.Plugin plugins} run
* code at specific time intervals, including thread safety.
*/
package org.bukkit.scheduler;

View File

@@ -1,5 +0,0 @@
/**
* Interfaces used to manage the client side score display system.
*/
package org.bukkit.scoreboard;

View File

@@ -1,5 +0,0 @@
/**
* Classes used to facilitate stream processing for specific Bukkit concepts.
*/
package org.bukkit.util.io;

View File

@@ -1,5 +0,0 @@
/**
* Classes dedicated to facilitating deterministic noise.
*/
package org.bukkit.util.noise;

View File

@@ -1,6 +0,0 @@
/**
* Multi and single purpose classes to facilitate various programmatic
* concepts.
*/
package org.bukkit.util;

View File

@@ -1,6 +0,0 @@
/**
* Static methods for miscellaneous {@link org.bukkit.permissions.Permission
* permission} functionality.
*/
package org.bukkit.util.permissions;