Permalink
Browse files

Merge pull request #426 from sk89q/feature/cleaner-javadoc

Cleanup javadoc warnings
  • Loading branch information...
me4502 committed Oct 2, 2018
2 parents aee011e + 388187d commit 6b33f08f3a60565e5b2d057eecf87f33ce5cffe0
@@ -98,7 +98,7 @@
Entity createEntity(Location location, BaseEntity state);
/**
* Get a map of string -> properties
* Get a map of {@code string -> property}.
*
* @param blockType The block type
* @return The properties map
@@ -526,7 +526,7 @@ public void setSuperPickaxe(BlockTool tool) {
* Get the tool assigned to the item.
*
* @param item the item type
* @return the tool, which may be {@link null}
* @return the tool, which may be {@code null}
*/
@Nullable
public Tool getTool(ItemType item) {
@@ -41,7 +41,7 @@
* Create a new instance.
*
* @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) {
super(extent);
@@ -51,7 +51,7 @@ public BlockChangeLimiter(Extent extent, int 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() {
return limit;
@@ -60,7 +60,7 @@ public int getLimit() {
/**
* 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) {
checkArgument(limit >= -1, "limit >= -1 required");
@@ -41,7 +41,7 @@
* <p>Supported operators:</p>
*
* <ul>
* <li>Logical: &&, ||, ! (unary)</li>
* <li>Logical: &amp;&amp;, ||, ! (unary)</li>
* <li>Bitwise: ~ (unary), &gt;&gt;, &lt;&lt;</li>
* <li>Arithmetic: +, -, *, /, % (modulo), ^ (power), - (unary), --, ++ (prefix only)</li>
* <li>Comparison: &lt;=, &gt;=, &gt;, &lt;, ==, !=, ~= (near)</li>
@@ -221,7 +221,7 @@ public static String stripColor(final String input) {
* 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.
*
* @param altColorChar The alternate color code character to replace. Ex: &
* @param altColorChar The alternate color code character to replace. Ex: &amp;
* @param textToTranslate Text containing the alternate color code character.
* @return Text containing the ChatColor.COLOR_CODE color code character.
*/
@@ -89,7 +89,7 @@ public String getName() {
}
/**
* 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
*/
@@ -46,8 +46,8 @@
public static final int DATA_VERSION_MC_1_13 = 1519;
/**
* >> to chunk
* << from chunk
* {@code >>} - to chunk
* {@code <<} - from chunk
*/
public static final int CHUNK_SHIFTS = 4;

0 comments on commit 6b33f08

Please sign in to comment.