Pulling all pending Bukkit-JavaDoc changes

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-09-10 21:02:53 -05:00
parent f60d6710d5
commit 67439804f4
61 changed files with 219 additions and 43 deletions

View File

@@ -3,6 +3,7 @@ package org.bukkit.command;
import org.bukkit.block.Block;
public interface BlockCommandSender extends CommandSender {
/**
* Returns the block this command sender belongs to
*

View File

@@ -11,6 +11,11 @@ public class MultipleCommandAlias extends Command {
this.commands = commands;
}
/**
* Gets the commands associated with the multi-command alias.
*
* @return commands associated with alias
*/
public Command[] getCommands() {
return commands;
}

View File

@@ -75,6 +75,7 @@ public final class PluginCommand extends Command implements PluginIdentifiableCo
/**
* Sets the {@link TabCompleter} to run when tab-completing this command.
* <p>
* If no TabCompleter is specified, and the command's executor implements
* TabCompleter, then the executor will be used for tab completion.
*
@@ -112,6 +113,7 @@ public final class PluginCommand extends Command implements PluginIdentifiableCo
* {@link Command#tabComplete(CommandSender, String, String[])}.<br>
* <br>
* This method does not consider permissions.
*
* @throws CommandException if the completer or executor throw an exception during the process of tab-completing.
* @throws IllegalArgumentException if sender, alias, or args is null
*/

View File

@@ -4,6 +4,7 @@ import java.util.List;
/**
* Represents a class which can handle command tab completion and commands
*
* @deprecated Remains for plugins that would have implemented it even without functionality
* @see TabExecutor
*/