JavaDoc fixes

This commit is contained in:
tastybento 2021-12-21 09:00:28 -08:00
parent 4702ad1b96
commit 3889975319
3 changed files with 8 additions and 9 deletions

View File

@ -24,7 +24,7 @@ public class CaveBlock extends GameModeAddon
/** /**
* Executes code when loading the addon. This is called before {@link #onEnable()}. This should preferably * Executes code when loading the addon. This is called before {@link #onEnable()}. This should preferably
* be used to setup configuration and worlds. * be used to set up configuration and worlds.
*/ */
@Override @Override
public void onLoad() public void onLoad()
@ -121,8 +121,8 @@ public class CaveBlock extends GameModeAddon
/** /**
* Make the worlds for this GameMode in this method. BentoBox will call it after onLoad() and before * Make the worlds for this GameMode in this method. BentoBox will call it after onLoad() and before
* onEnable(). {@link #islandWorld} must be created and assigned, {@link #netherWorld} and {@link * onEnable(). {@code islandWorld} must be created and assigned, {@code netherWorld} and {@code
* #endWorld} are optional and may be null. * endWorld} are optional and may be null.
*/ */
@Override @Override
public void createWorlds() public void createWorlds()

View File

@ -5,7 +5,6 @@ import org.bukkit.Material;
/** /**
* @author tastybento * @author tastybento
* @param minY minimum Y level this ore should appear * @param minY minimum Y level this ore should appear
* @param minY maximum Y level this ore should appear
* @param material Material * @param material Material
* @param chance chance * @param chance chance
* @param blob maximum size of blob to generate * @param blob maximum size of blob to generate

View File

@ -16,14 +16,14 @@ import world.bentobox.caveblock.CaveBlock;
/** /**
* This listener checks player movement. If enabled, players will be deny to get over world depth limit and * This listener checks player movement. If enabled, players will be denied to get over world depth limit and
* if alternative teleports is enabled, then falling in void also will be processed. * if alternative teleports is enabled, then falling in void also will be processed.
*/ */
public class CustomHeightLimitations implements Listener public class CustomHeightLimitations implements Listener
{ {
/** /**
* Simple constructor * Simple constructor
* @param addon * @param addon Addon
*/ */
public CustomHeightLimitations(CaveBlock addon) public CustomHeightLimitations(CaveBlock addon)
{ {
@ -86,7 +86,7 @@ public class CustomHeightLimitations implements Listener
/** /**
* This method checks and returns if current player movement from location to to location should be * This method checks and returns if current player movement from location to location should be
* managed by current addon. * managed by current addon.
* @param nextY NextY location for player. * @param nextY NextY location for player.
* @param player Player who makes movement * @param player Player who makes movement
@ -120,10 +120,10 @@ public class CustomHeightLimitations implements Listener
/** /**
* CaveBlock addon * CaveBlock addon
*/ */
private CaveBlock addon; private final CaveBlock addon;
/** /**
* This variable store world height. * This variable store world height.
*/ */
private int worldHeight; private final int worldHeight;
} }