Fix some of the JavaDoc.
This commit is contained in:
		@@ -331,7 +331,7 @@ public class JailIO {
 | 
				
			|||||||
	}
 | 
						}
 | 
				
			||||||
	
 | 
						
 | 
				
			||||||
	/**
 | 
						/**
 | 
				
			||||||
	 * Loads the jails, this should <strong>only</strong> be called after {@link #prepareStorage()}.
 | 
						 * Loads the jails, this should <strong>only</strong> be called after {@link #prepareStorage(boolean)}.
 | 
				
			||||||
	 */
 | 
						 */
 | 
				
			||||||
	public void loadJails() {
 | 
						public void loadJails() {
 | 
				
			||||||
		switch(storage) {
 | 
							switch(storage) {
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -132,7 +132,7 @@ public class JailStickManager {
 | 
				
			|||||||
	/**
 | 
						/**
 | 
				
			||||||
	 * Toggles whether the player is using a jail stick, returning the true if enabled false if disabled.
 | 
						 * Toggles whether the player is using a jail stick, returning the true if enabled false if disabled.
 | 
				
			||||||
	 * 
 | 
						 * 
 | 
				
			||||||
	 * @param name of the person to toggle
 | 
						 * @param player to toggle using a stick
 | 
				
			||||||
	 * @return true if we enabled it, false if we disabled it.
 | 
						 * @return true if we enabled it, false if we disabled it.
 | 
				
			||||||
	 */
 | 
						 */
 | 
				
			||||||
	public boolean toggleUsingStick(Player player) {
 | 
						public boolean toggleUsingStick(Player player) {
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -435,7 +435,7 @@ public class PrisonerManager {
 | 
				
			|||||||
	/**
 | 
						/**
 | 
				
			||||||
	 * Transfers the prisoner from one jail, or cell, to another jail, and/or cell.
 | 
						 * Transfers the prisoner from one jail, or cell, to another jail, and/or cell.
 | 
				
			||||||
	 * 
 | 
						 * 
 | 
				
			||||||
	 * @param origin The jail where they are coming from.
 | 
						 * @param originJail The jail where they are coming from.
 | 
				
			||||||
	 * @param originCell The cell where they are coming from.
 | 
						 * @param originCell The cell where they are coming from.
 | 
				
			||||||
	 * @param targetJail The jail we're transferring them from.
 | 
						 * @param targetJail The jail we're transferring them from.
 | 
				
			||||||
	 * @param targetCell The cell we're putting them into.
 | 
						 * @param targetCell The cell we're putting them into.
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -52,15 +52,15 @@ public class CommandHandler {
 | 
				
			|||||||
	 * 
 | 
						 * 
 | 
				
			||||||
	 * @param jailmanager The instance of {@link JailManager}.
 | 
						 * @param jailmanager The instance of {@link JailManager}.
 | 
				
			||||||
	 * @param sender The sender of the command.
 | 
						 * @param sender The sender of the command.
 | 
				
			||||||
	 * @param command The name of the command.
 | 
						 * @param commandLine The name of the command.
 | 
				
			||||||
	 * @param args The arguments passed to the command.
 | 
						 * @param args The arguments passed to the command.
 | 
				
			||||||
	 */
 | 
						 */
 | 
				
			||||||
	public void handleCommand(JailManager jailmanager, CommandSender sender, String command, String[] args) {
 | 
						public void handleCommand(JailManager jailmanager, CommandSender sender, String commandLine, String[] args) {
 | 
				
			||||||
		List<Command> matches = getMatches(command);
 | 
							List<Command> matches = getMatches(commandLine);
 | 
				
			||||||
		
 | 
							
 | 
				
			||||||
		//If no matches were found, send them the unknown command message.
 | 
							//If no matches were found, send them the unknown command message.
 | 
				
			||||||
		if(matches.size() == 0) {
 | 
							if(matches.size() == 0) {
 | 
				
			||||||
			sender.sendMessage(jailmanager.getPlugin().getJailIO().getLanguageString(LangString.UNKNOWNCOMMAND, command));
 | 
								sender.sendMessage(jailmanager.getPlugin().getJailIO().getLanguageString(LangString.UNKNOWNCOMMAND, commandLine));
 | 
				
			||||||
			return;
 | 
								return;
 | 
				
			||||||
		}
 | 
							}
 | 
				
			||||||
		
 | 
							
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -38,7 +38,7 @@ public class PrePrisonerTransferredEvent extends Event implements Cancellable {
 | 
				
			|||||||
	 * @param targetCell The cell the prisoner is going to, can be null.
 | 
						 * @param targetCell The cell the prisoner is going to, can be null.
 | 
				
			||||||
	 * @param prisoner The prisoner data.
 | 
						 * @param prisoner The prisoner data.
 | 
				
			||||||
	 * @param player The player being jailed.
 | 
						 * @param player The player being jailed.
 | 
				
			||||||
	 * @param targetCell The name of what is transferring this prisoner.
 | 
						 * @param transferor The name of what is transferring this prisoner.
 | 
				
			||||||
	 */
 | 
						 */
 | 
				
			||||||
	public PrePrisonerTransferredEvent(Jail originalJail, Cell originalCell, Jail targetJail, Cell targetCell, Prisoner prisoner, Player player, String transferor) {
 | 
						public PrePrisonerTransferredEvent(Jail originalJail, Cell originalCell, Jail targetJail, Cell targetCell, Prisoner prisoner, Player player, String transferor) {
 | 
				
			||||||
		this.originalJail = originalJail;
 | 
							this.originalJail = originalJail;
 | 
				
			||||||
@@ -116,7 +116,7 @@ public class PrePrisonerTransferredEvent extends Event implements Cancellable {
 | 
				
			|||||||
	/**
 | 
						/**
 | 
				
			||||||
	 * Sets the prisoner whom the data should say jailed this prisoner.
 | 
						 * Sets the prisoner whom the data should say jailed this prisoner.
 | 
				
			||||||
	 * 
 | 
						 * 
 | 
				
			||||||
	 * @param jailer The name to put who is the jailer for this prisoner.
 | 
						 * @param transferor The name to put who is the jailer for this prisoner.
 | 
				
			||||||
	 */
 | 
						 */
 | 
				
			||||||
	public void setTransferor(String transferor) {
 | 
						public void setTransferor(String transferor) {
 | 
				
			||||||
		this.transferor = transferor;
 | 
							this.transferor = transferor;
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -35,8 +35,6 @@ public class PrisonerJailedEvent extends Event {
 | 
				
			|||||||
	 * @param cell The cell we're going to be sending the prisoner to, can be null.
 | 
						 * @param cell The cell we're going to be sending the prisoner to, can be null.
 | 
				
			||||||
	 * @param prisoner The prisoner data.
 | 
						 * @param prisoner The prisoner data.
 | 
				
			||||||
	 * @param player The player being jailed.
 | 
						 * @param player The player being jailed.
 | 
				
			||||||
	 * @param online Whether the player is online or not.
 | 
					 | 
				
			||||||
	 * @param jailer The name of what jailed this prisoner.
 | 
					 | 
				
			||||||
	 */
 | 
						 */
 | 
				
			||||||
	public PrisonerJailedEvent(Jail jail, Cell cell, Prisoner prisoner, Player player) {
 | 
						public PrisonerJailedEvent(Jail jail, Cell cell, Prisoner prisoner, Player player) {
 | 
				
			||||||
		this.jail = jail;
 | 
							this.jail = jail;
 | 
				
			||||||
@@ -60,7 +58,7 @@ public class PrisonerJailedEvent extends Event {
 | 
				
			|||||||
		return this.prisoner;
 | 
							return this.prisoner;
 | 
				
			||||||
	}
 | 
						}
 | 
				
			||||||
	
 | 
						
 | 
				
			||||||
	/** Gets the instance of the player being jailed <strong>but will return null if {@link #isOnline()} returns false</strong>. */
 | 
						/** Gets the instance of the player being jailed. */
 | 
				
			||||||
	public Player getPlayer() {
 | 
						public Player getPlayer() {
 | 
				
			||||||
		return this.player;
 | 
							return this.player;
 | 
				
			||||||
	}
 | 
						}
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user