mirror of
https://github.com/plexusorg/Plex-FAWE.git
synced 2024-11-05 12:26:06 +00:00
Merge pull request #426 from sk89q/feature/cleaner-javadoc
Cleanup javadoc warnings
This commit is contained in:
commit
6b33f08f3a
@ -98,7 +98,7 @@ public interface BukkitImplAdapter {
|
|||||||
Entity createEntity(Location location, BaseEntity state);
|
Entity createEntity(Location location, BaseEntity state);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a map of string -> properties
|
* Get a map of {@code string -> property}.
|
||||||
*
|
*
|
||||||
* @param blockType The block type
|
* @param blockType The block type
|
||||||
* @return The properties map
|
* @return The properties map
|
||||||
|
@ -526,7 +526,7 @@ public class LocalSession {
|
|||||||
* Get the tool assigned to the item.
|
* Get the tool assigned to the item.
|
||||||
*
|
*
|
||||||
* @param item the item type
|
* @param item the item type
|
||||||
* @return the tool, which may be {@link null}
|
* @return the tool, which may be {@code null}
|
||||||
*/
|
*/
|
||||||
@Nullable
|
@Nullable
|
||||||
public Tool getTool(ItemType item) {
|
public Tool getTool(ItemType item) {
|
||||||
|
@ -41,7 +41,7 @@ public class BlockChangeLimiter extends AbstractDelegateExtent {
|
|||||||
* Create a new instance.
|
* Create a new instance.
|
||||||
*
|
*
|
||||||
* @param extent the extent
|
* @param extent the extent
|
||||||
* @param limit the limit (>= 0) or -1 for no limit
|
* @param limit the limit (>= 0) or -1 for no limit
|
||||||
*/
|
*/
|
||||||
public BlockChangeLimiter(Extent extent, int limit) {
|
public BlockChangeLimiter(Extent extent, int limit) {
|
||||||
super(extent);
|
super(extent);
|
||||||
@ -51,7 +51,7 @@ public class BlockChangeLimiter extends AbstractDelegateExtent {
|
|||||||
/**
|
/**
|
||||||
* Get the limit.
|
* Get the limit.
|
||||||
*
|
*
|
||||||
* @return the limit (>= 0) or -1 for no limit
|
* @return the limit (>= 0) or -1 for no limit
|
||||||
*/
|
*/
|
||||||
public int getLimit() {
|
public int getLimit() {
|
||||||
return limit;
|
return limit;
|
||||||
@ -60,7 +60,7 @@ public class BlockChangeLimiter extends AbstractDelegateExtent {
|
|||||||
/**
|
/**
|
||||||
* Set the limit.
|
* Set the limit.
|
||||||
*
|
*
|
||||||
* @param limit the limit (>= 0) or -1 for no limit
|
* @param limit the limit (>= 0) or -1 for no limit
|
||||||
*/
|
*/
|
||||||
public void setLimit(int limit) {
|
public void setLimit(int limit) {
|
||||||
checkArgument(limit >= -1, "limit >= -1 required");
|
checkArgument(limit >= -1, "limit >= -1 required");
|
||||||
|
@ -41,7 +41,7 @@ import java.util.Stack;
|
|||||||
* <p>Supported operators:</p>
|
* <p>Supported operators:</p>
|
||||||
*
|
*
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>Logical: &&, ||, ! (unary)</li>
|
* <li>Logical: &&, ||, ! (unary)</li>
|
||||||
* <li>Bitwise: ~ (unary), >>, <<</li>
|
* <li>Bitwise: ~ (unary), >>, <<</li>
|
||||||
* <li>Arithmetic: +, -, *, /, % (modulo), ^ (power), - (unary), --, ++ (prefix only)</li>
|
* <li>Arithmetic: +, -, *, /, % (modulo), ^ (power), - (unary), --, ++ (prefix only)</li>
|
||||||
* <li>Comparison: <=, >=, >, <, ==, !=, ~= (near)</li>
|
* <li>Comparison: <=, >=, >, <, ==, !=, ~= (near)</li>
|
||||||
|
@ -221,7 +221,7 @@ public enum Style {
|
|||||||
* ChatColor.COLOR_CODE color code character. The alternate color code character will only be replaced
|
* ChatColor.COLOR_CODE color code character. The alternate color code character will only be replaced
|
||||||
* if it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r.
|
* if it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r.
|
||||||
*
|
*
|
||||||
* @param altColorChar The alternate color code character to replace. Ex: &
|
* @param altColorChar The alternate color code character to replace. Ex: &
|
||||||
* @param textToTranslate Text containing the alternate color code character.
|
* @param textToTranslate Text containing the alternate color code character.
|
||||||
* @return Text containing the ChatColor.COLOR_CODE color code character.
|
* @return Text containing the ChatColor.COLOR_CODE color code character.
|
||||||
*/
|
*/
|
||||||
|
@ -89,7 +89,7 @@ public class BlockType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the properties of this BlockType in a key->property mapping.
|
* Gets the properties of this BlockType in a {@code key->property} mapping.
|
||||||
*
|
*
|
||||||
* @return The properties map
|
* @return The properties map
|
||||||
*/
|
*/
|
||||||
|
@ -46,8 +46,8 @@ public abstract class ChunkStore implements Closeable {
|
|||||||
public static final int DATA_VERSION_MC_1_13 = 1519;
|
public static final int DATA_VERSION_MC_1_13 = 1519;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* >> to chunk
|
* {@code >>} - to chunk
|
||||||
* << from chunk
|
* {@code <<} - from chunk
|
||||||
*/
|
*/
|
||||||
public static final int CHUNK_SHIFTS = 4;
|
public static final int CHUNK_SHIFTS = 4;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user