Pulling all pending Bukkit-JavaDoc changes

By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-08-03 21:46:30 -04:00
parent b9642786eb
commit 599ec05858
80 changed files with 259 additions and 43 deletions

View File

@@ -18,6 +18,7 @@ public abstract class NumericPrompt extends ValidatingPrompt{
/**
* Override this method to do further validation on the numeric player input after the input has been determined
* to actually be a number.
*
* @param context Context information about the conversation.
* @param input The number the player provided.
* @return The validity of the player's input.
@@ -38,6 +39,7 @@ public abstract class NumericPrompt extends ValidatingPrompt{
/**
* Override this method to perform some action with the user's integer response.
*
* @param context Context information about the conversation.
* @param input The user's response as a {@link Number}.
* @return The next {@link Prompt} in the prompt graph.
@@ -55,6 +57,7 @@ public abstract class NumericPrompt extends ValidatingPrompt{
/**
* Optionally override this method to display an additional message if the user enters an invalid number.
*
* @param context Context information about the conversation.
* @param invalidInput The invalid input provided by the user.
* @return A message explaining how to correct the input.
@@ -65,6 +68,7 @@ public abstract class NumericPrompt extends ValidatingPrompt{
/**
* Optionally override this method to display an additional message if the user enters an invalid numeric input.
*
* @param context Context information about the conversation.
* @param invalidInput The invalid input provided by the user.
* @return A message explaining how to correct the input.