Cleanup Javadocs

This commit is contained in:
filoghost 2020-06-07 20:52:39 +02:00
parent f7fdca0d07
commit 10a1b8522a

View File

@ -25,7 +25,7 @@ public class ChestCommandsAPI {
/** /**
* Checks if a menu with a given file name was loaded by the plugin. * Checks if a menu with a given file name was loaded by the plugin.
* *
* @return true - if the menu was found. * @return if the menu was found
*/ */
public static boolean isPluginMenu(String yamlFile) { public static boolean isPluginMenu(String yamlFile) {
return BackendAPI.getImplementation().getMenuByFileName(yamlFile) != null; return BackendAPI.getImplementation().getMenuByFileName(yamlFile) != null;
@ -35,9 +35,9 @@ public class ChestCommandsAPI {
* Opens a menu loaded by ChestCommands to a player. * Opens a menu loaded by ChestCommands to a player.
* NOTE: this method ignores permissions. * NOTE: this method ignores permissions.
* *
* @param player - the player that will see the GUI. * @param player the player that will see the menu
* @param yamlFile - the file name of the menu to open. The .yml extension CANNOT be omitted. * @param yamlFile the file name of the menu to open (with the .yml extension)
* @return true - if the menu was found and opened, false if not. * @return if the menu was found and opened
*/ */
public static boolean openPluginMenu(Player player, String yamlFile) { public static boolean openPluginMenu(Player player, String yamlFile) {
IconMenu menu = BackendAPI.getImplementation().getMenuByFileName(yamlFile); IconMenu menu = BackendAPI.getImplementation().getMenuByFileName(yamlFile);