Misc documentation fixes from @rlf

This commit is contained in:
rlf 2016-11-19 14:17:26 -07:00 committed by Eric Stokes
parent 8fdc0ad3da
commit aba1f05c5b
6 changed files with 13 additions and 8 deletions

View File

@ -138,6 +138,11 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
/** /**
* This is for unit testing. * This is for unit testing.
* @deprecated * @deprecated
* @param loader deprecated
* @param server deprecated
* @param description deprecated
* @param dataFolder deprecated
* @param file deprecated
*/ */
@Deprecated @Deprecated
public MultiverseCore(PluginLoader loader, Server server, PluginDescriptionFile description, File dataFolder, File file) { public MultiverseCore(PluginLoader loader, Server server, PluginDescriptionFile description, File dataFolder, File file) {

View File

@ -199,7 +199,7 @@ public interface MVWorldManager {
boolean isMVWorld(World world); boolean isMVWorld(World world);
/** /**
* Load the Worlds & Settings from the configuration file. * Load the Worlds & Settings from the configuration file.
* *
* @param forceLoad If set to true, this will perform a total * @param forceLoad If set to true, this will perform a total
* reset and not just load new worlds. * reset and not just load new worlds.
@ -207,7 +207,7 @@ public interface MVWorldManager {
void loadWorlds(boolean forceLoad); void loadWorlds(boolean forceLoad);
/** /**
* Loads the Worlds & Settings for any worlds that bukkit loaded before us. * Loads the Worlds & Settings for any worlds that bukkit loaded before us.
* <p> * <p>
* This way people will _always_ have some worlds in the list. * This way people will _always_ have some worlds in the list.
*/ */

View File

@ -17,7 +17,7 @@ public interface WorldPurger {
void purgeWorlds(List<MultiverseWorld> worlds); void purgeWorlds(List<MultiverseWorld> worlds);
/** /**
* Convenience method for {@link #purgeWorld(CommandSender, MultiverseWorld, List, boolean, boolean)} that takes the settings from the world-config. * Convenience method for {@link #purgeWorld(MultiverseWorld, java.util.List, boolean, boolean)} that takes the settings from the world-config.
* *
* @param world The {@link MultiverseWorld}. * @param world The {@link MultiverseWorld}.
*/ */

View File

@ -22,9 +22,9 @@ public class FancyMessage implements FancyText {
* Allows easy creation of an alternating colored list. * Allows easy creation of an alternating colored list.
* TODO: Documentation! Why does CheckStyle just ignore this? * TODO: Documentation! Why does CheckStyle just ignore this?
* *
* @param title * @param title The title.
* @param message * @param message The body of the message.
* @param scheme * @param scheme The color scheme to use for easy styling.
*/ */
public FancyMessage(String title, String message, FancyColorScheme scheme) { public FancyMessage(String title, String message, FancyColorScheme scheme) {
this.title = title; this.title = title;

View File

@ -230,7 +230,7 @@ public class MVPermissions implements PermissionsInterface {
* *
* @param sender Who is requesting the permission. * @param sender Who is requesting the permission.
* @param node The permission node in string format; multiverse.core.list.worlds for example. * @param node The permission node in string format; multiverse.core.list.worlds for example.
* @param isOpRequired @Deprecated. This is not used for anything anymore. * @param isOpRequired deprecated This is not used for anything anymore.
* @return True if they have that permission or any parent. * @return True if they have that permission or any parent.
*/ */
@Override @Override

View File

@ -27,7 +27,7 @@ import java.util.logging.Level;
/** /**
* Utility class that removes animals from worlds that don't belong there. * Utility class that removes animals from worlds that don't belong there.
* *
* @deprecated Use instead: {@link WorldPurger} and {@link SimpleWorldPurger}. * @deprecated Use instead: {@link com.onarandombox.MultiverseCore.api.WorldPurger} and {@link SimpleWorldPurger}.
*/ */
@Deprecated @Deprecated
public class PurgeWorlds { public class PurgeWorlds {