JavadocStyleCheck: First sentence should end with a period.

Yes, one character can be that important. *sigh*
This commit is contained in:
main() 2011-12-12 17:40:33 +01:00
parent ca21047859
commit cab8aaf040
23 changed files with 26 additions and 77 deletions

View File

@ -385,7 +385,7 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
}
/**
* Grab the Permissions Handler for Multiverse
* Grab the Permissions Handler for Multiverse.
*
* @return A valid {@link MVPermissions}.
*/
@ -394,7 +394,7 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
}
/**
* onCommand
* {@inheritDoc}
*/
@Override
public boolean onCommand(CommandSender sender, Command command, String commandLabel, String[] args) {

View File

@ -39,7 +39,7 @@ public interface MVWorldManager {
/**
* Remove the world from the Multiverse list, from the
* config and deletes the folder
* config and deletes the folder.
*
* @param name The name of the world to remove
* @return True if success, false if failure.
@ -48,7 +48,7 @@ public interface MVWorldManager {
/**
* Remove the world from the Multiverse list, from the
* config and deletes the folder
* config if wanted, and deletes the folder.
*
* @param name The name of the world to remove
* @param removeConfig If true(default), we'll remove the entries from the
@ -58,7 +58,7 @@ public interface MVWorldManager {
public Boolean deleteWorld(String name, boolean removeConfig);
/**
* Unload a world from Multiverse
* Unload a world from Multiverse.
*
* @param name Name of the world to unload
* @return True if the world was unloaded, false if not.
@ -117,7 +117,7 @@ public interface MVWorldManager {
public MultiverseWorld getMVWorld(World world);
/**
* Checks to see if the given name is a valid {@link MultiverseWorld}
* Checks to see if the given name is a valid {@link MultiverseWorld}.
*
* @param name The name or alias of the world to check.
* @return True if the world exists, false if not.
@ -125,7 +125,7 @@ public interface MVWorldManager {
public boolean isMVWorld(String name);
/**
* Checks to see if the given world is a valid {@link MultiverseWorld}
* Checks to see if the given world is a valid {@link MultiverseWorld}.
*
* @param world The Bukkit world to check.
* @return True if the world has been loaded into MV2, false if not.
@ -190,7 +190,7 @@ public interface MVWorldManager {
public boolean saveWorldsConfig();
/**
* Remove the world from the Multiverse list and from the config
* Remove the world from the Multiverse list and from the config.
*
* @param name The name of the world to remove
* @return True if success, false if failure.

View File

@ -320,7 +320,7 @@ public interface MultiverseWorld {
boolean getHunger();
/**
* Sets the game mode of this world
* Sets the game mode of this world.
*
* @param gameMode A valid game mode string (either
* an int ex. 0 or a string ex. creative).
@ -523,7 +523,7 @@ public interface MultiverseWorld {
boolean getBedRespawn();
/**
* Gets all the names of all properties that can be SET
* Gets all the names of all properties that can be SET.
*
* @return All property names, with alternating colors.
*/

View File

@ -14,11 +14,6 @@ import org.bukkit.plugin.java.JavaPlugin;
import java.util.List;
/**
* Multiverse 2
*
* @author fernferret
*/
public abstract class PaginatedCommand<T> extends Command {
protected int itemsPerPage = 9;

View File

@ -9,11 +9,6 @@ package com.onarandombox.MultiverseCore.commands;
import com.onarandombox.MultiverseCore.MultiverseCore;
/**
* Multiverse 2
*
* @author fernferret
*/
public abstract class PaginatedCoreCommand<T> extends PaginatedCommand<T> {
protected MultiverseCore plugin;

View File

@ -30,14 +30,14 @@ public interface MVConfigProperty<T> {
String toString();
/**
* Gets the help string for this
* Gets the help string for this.
*
* @return The value of this property as a string.
*/
String getHelp();
/**
* Sets the value of this property
* Sets the value of this property.
*
* @param value The T representation of this value.
*/

View File

@ -58,11 +58,6 @@ public class StringConfigProperty implements MVConfigProperty<String> {
return value;
}
/**
* Gets the help string for this
*
* @return The value of this property as a string.
*/
@Override
public String getHelp() {
return this.help;

View File

@ -14,11 +14,6 @@ import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.util.Vector;
/**
* Multiverse 2
*
* @author fernferret
*/
public class BedDestination implements MVDestination {
private boolean isValid;

View File

@ -7,11 +7,6 @@
package com.onarandombox.MultiverseCore.enums;
/**
* Multiverse 2
*
* @author fernferret
*/
public enum Action {
Set, Add, Remove, Clear
}

View File

@ -7,11 +7,6 @@
package com.onarandombox.MultiverseCore.enums;
/**
* Multiverse 2
*
* @author fernferret
*/
public enum AddProperties {
worldblacklist, animals, monsters
}

View File

@ -7,7 +7,6 @@
package com.onarandombox.MultiverseCore.enums;
/** Multiverse 2 */
public enum ConfigProperty {
messagecooldown, teleportcooldown, worldnameprefix, enforcegamemodes, enforceaccess, debug;

View File

@ -9,11 +9,6 @@ package com.onarandombox.MultiverseCore.enums;
import org.bukkit.ChatColor;
/**
* Multiverse 2
*
* @author fernferret
*/
public enum EnglishChatColor {
AQUA("AQUA", ChatColor.AQUA),
BLACK("BLACK", ChatColor.BLACK),

View File

@ -15,7 +15,7 @@ import org.bukkit.event.Cancellable;
import org.bukkit.event.Event;
/**
* Event that gets called when a player use the /mvtp command
* Event that gets called when a player use the /mvtp command.
*
* @author fernferret
*/
@ -53,7 +53,7 @@ public class MVTeleportEvent extends Event implements Cancellable {
}
/**
* Gets the {@link CommandSender} who requested the Teleport
* Gets the {@link CommandSender} who requested the Teleport.
*
* @return The {@link CommandSender} who requested the Teleport
*/

View File

@ -23,11 +23,6 @@ import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
/**
* Multiverse 2
*
* @author fernferret
*/
public class AnchorManager {
private MultiverseCore plugin;
private Map<String, Location> anchors;

View File

@ -194,7 +194,7 @@ public class BlockSafety {
}
/**
* Checks recursively below a {@link Location} for 2 blocks of water
* Checks recursively below a {@link Location} for 2 blocks of water.
*
* @param l The {@link Location}
* @return Whether there are 2 blocks of water

View File

@ -49,7 +49,7 @@ public class DebugLog {
}
/**
* Log a message at a certain level
* Log a message at a certain level.
*
* @param level
* @param msg

View File

@ -16,7 +16,7 @@ public class FancyMessage implements FancyText {
private FancyColorScheme colors;
/**
* Allows easy creation of an alternating colored list
* Allows easy creation of an alternating colored list.
*
* @param title
* @param message

View File

@ -107,7 +107,7 @@ public class LocationManipulation {
}
/**
* Returns a colored string with the coords
* Returns a colored string with the coords.
*
* @param l The {@link Location}
* @return The {@link String}
@ -126,7 +126,7 @@ public class LocationManipulation {
}
/**
* Converts a location to a printable readable formatted string including pitch/yaw
* Converts a location to a printable readable formatted string including pitch/yaw.
*
* @param l The {@link Location}
* @return The {@link String}
@ -177,7 +177,7 @@ public class LocationManipulation {
}
/**
* Returns the float yaw position for the given cardinal direction
* Returns the float yaw position for the given cardinal direction.
*
* @param orientation The cardinal direction
* @return The yaw
@ -206,7 +206,7 @@ public class LocationManipulation {
// -W/+E,0, -N/+S
/**
* Returns a translated vector from the given direction
* Returns a translated vector from the given direction.
*
* @param v The old {@link Vector}
* @param direction The new direction
@ -240,7 +240,7 @@ public class LocationManipulation {
}
/**
* Returns the next Location that a {@link Vehicle} is traveling at
* Returns the next Location that a {@link Vehicle} is traveling at.
*
* @param v The {@link Vehicle}
* @return The {@link Location}

View File

@ -15,11 +15,6 @@ import java.util.Date;
import java.util.HashMap;
import java.util.Map;
/**
* Multiverse 2
*
* @author fernferret
*/
public class MVMessaging {
private MultiverseCore plugin;
private Map<String, Date> sentList;

View File

@ -26,11 +26,6 @@ public class MVPermissions implements PermissionsInterface {
private MultiverseCore plugin;
private MVWorldManager worldMgr;
/**
* Constructor FTW
*
* @param plugin Pass along the Core Plugin.
*/
public MVPermissions(MultiverseCore plugin) {
this.plugin = plugin;
this.worldMgr = plugin.getMVWorldManager();

View File

@ -32,7 +32,7 @@ public class PurgeWorlds {
this.plugin = plugin;
}
/** Synchronizes the given world with it's settings */
/** Synchronizes the given world with it's settings. */
public void purgeWorlds(CommandSender sender, List<MultiverseWorld> worlds) {
if (worlds == null || worlds.isEmpty()) {
return;
@ -104,7 +104,7 @@ public class PurgeWorlds {
}
/**
* Will kill the monster if it's in the list UNLESS the NEGATE boolean is set, then it will kill it if it's NOT
* Will kill the monster if it's in the list UNLESS the NEGATE boolean is set, then it will kill it if it's NOT.
*
* @param mvworld
* @param e

View File

@ -96,7 +96,7 @@ public class SafeTTeleporter {
}
/**
* For my crappy algorithm, radius MUST be odd
* For my crappy algorithm, radius MUST be odd.
*
* @param l
* @param diameter

View File

@ -299,7 +299,7 @@ public class WorldManager implements MVWorldManager {
}
/**
* Unload a world from Bukkit
* Unload a world from Bukkit.
*
* @param name Name of the world to unload
* @param safely Perform this safely. Set to True to save world files before unloading.