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

@@ -9,6 +9,7 @@ public interface Conversable {
/**
* Tests to see of a Conversable object is actively engaged in a conversation.
*
* @return True if a conversation is in progress
*/
public boolean isConversing();
@@ -16,12 +17,14 @@ public interface Conversable {
/**
* Accepts input into the active conversation. If no conversation is in progress,
* this method does nothing.
*
* @param input The input message into the conversation
*/
public void acceptConversationInput(String input);
/**
* Enters into a dialog with a Conversation object.
*
* @param conversation The conversation to begin
* @return True if the conversation should proceed, false if it has been enqueued
*/
@@ -29,12 +32,14 @@ public interface Conversable {
/**
* Abandons an active conversation.
*
* @param conversation The conversation to abandon
*/
public void abandonConversation(Conversation conversation);
/**
* Abandons an active conversation.
*
* @param conversation The conversation to abandon
* @param details Details about why the conversation was abandoned
*/