Pulling all pending Bukkit-JavaDoc changes

A special thanks goes to @aerouk for almost all of the changes found here.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions

View File

@@ -5,16 +5,19 @@ public interface Tameable {
/**
* Check if this is tamed
* <p>
* If something is tamed then a player can not tame it through normal methods, even if it does not belong to anyone in particular.
* If something is tamed then a player can not tame it through normal
* methods, even if it does not belong to anyone in particular.
*
* @return true if this has been tamed
*/
public boolean isTamed();
/**
* Sets if this has been tamed. Not necessary if the method setOwner has been used, as it tames automatically.
* Sets if this has been tamed. Not necessary if the method setOwner has
* been used, as it tames automatically.
* <p>
* If something is tamed then a player can not tame it through normal methods, even if it does not belong to anyone in particular.
* If something is tamed then a player can not tame it through normal
* methods, even if it does not belong to anyone in particular.
*
* @param tame true if tame
*/
@@ -29,8 +32,10 @@ public interface Tameable {
/**
* Set this to be owned by given AnimalTamer.
* If the owner is not null, this will be tamed and will have any current path it is following removed.
* If the owner is set to null, this will be untamed, and the current owner removed.
* <p>
* If the owner is not null, this will be tamed and will have any current
* path it is following removed. If the owner is set to null, this will be
* untamed, and the current owner removed.
*
* @param tamer the AnimalTamer who should own this
*/