From 61a225937d44a82c396cba9eec50e6bf164e141f Mon Sep 17 00:00:00 2001 From: boy0001 Date: Fri, 13 Mar 2015 18:26:08 +1100 Subject: [PATCH] More jdoc stuff --- PlotSquared/pom.xml | 1 + .../jnbt/ListTagBuilder.java | 5 ++ .../jnbt/NBTInputStream.java | 4 +- .../jnbt/NBTOutputStream.java | 3 +- .../intellectualcrafters/jnbt/NBTUtils.java | 1 + .../com/intellectualcrafters/json/HTTP.java | 53 ------------------ .../com/intellectualcrafters/json/JSONML.java | 1 - .../intellectualcrafters/json/JSONObject.java | 1 - .../com/intellectualcrafters/json/XML.java | 56 ------------------- .../intellectualcrafters/json/XMLTokener.java | 10 ++-- .../plot/api/PlotAPI.java | 12 ++-- .../plot/flag/AbstractFlag.java | 2 +- .../intellectualcrafters/plot/flag/Flag.java | 2 +- .../plot/flag/FlagManager.java | 2 +- .../plot/object/Plot.java | 4 +- 15 files changed, 27 insertions(+), 130 deletions(-) diff --git a/PlotSquared/pom.xml b/PlotSquared/pom.xml index 2af82a31f..faead4fd6 100644 --- a/PlotSquared/pom.xml +++ b/PlotSquared/pom.xml @@ -43,6 +43,7 @@ public false + -Xdoclint:none diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/ListTagBuilder.java b/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/ListTagBuilder.java index c076aaf80..af94f866d 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/ListTagBuilder.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/ListTagBuilder.java @@ -27,6 +27,8 @@ public class ListTagBuilder { /** * Create a new builder instance. + * + * @param type * * @return a new builder */ @@ -36,6 +38,9 @@ public class ListTagBuilder { /** * Create a new builder instance. + * + * @param entries + * @param * * @return a new builder */ diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTInputStream.java b/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTInputStream.java index 7bf7ae2c9..ef73bb881 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTInputStream.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTInputStream.java @@ -11,8 +11,8 @@ import java.util.Map; /** * This class reads NBT, or Named Binary Tag streams, and produces an object graph of - * subclasses of the {@code Tag} object.

The NBT format was created by Markus Persson, and the specification - * may be found at http://www.minecraft.net/docs/NBT.txt.

+ * subclasses of the {@code Tag} object. The NBT format was created by Markus Persson, and the specification + * may be found at @linktourl http://www.minecraft.net/docs/NBT.txt"> http://www.minecraft.net/docs/NBT.txt. */ public final class NBTInputStream implements Closeable { private final DataInputStream is; diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTOutputStream.java b/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTOutputStream.java index 9db7fb9e4..452784981 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTOutputStream.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTOutputStream.java @@ -29,7 +29,8 @@ import java.util.List; /** *

This class writes NBT, or Named Binary Tag Tag objects to an * underlying OutputStream.

The NBT format was created by Markus Persson, and the - * specification may be found at http://www.minecraft.net/docs/NBT.txt. + * specification may be found at + * @linktourl http://www.minecraft.net/docs/NBT.txt *

* * @author Graham Edgecombe diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTUtils.java b/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTUtils.java index d56c9808e..06b23b22c 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTUtils.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/jnbt/NBTUtils.java @@ -134,6 +134,7 @@ public final class NBTUtils { * @param items the map to read from * @param key the key to look for * @param expected the expected NBT class type + * @param * * @return child tag */ diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/json/HTTP.java b/PlotSquared/src/main/java/com/intellectualcrafters/json/HTTP.java index ee8594944..2e5f2b763 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/json/HTTP.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/json/HTTP.java @@ -34,59 +34,6 @@ public class HTTP { */ public static final String CRLF = "\r\n"; - /** - * Convert an HTTP header string into a JSONObject. It can be a request header or a response header. A request - * header will contain - * - * - * 
-     * {
-     *    Method: "POST" (for example),
-     *    "Request-URI": "/" (for example),
-     *    "HTTP-Version": "HTTP/1.1" (for example)
-     * }
-     *
- * - * A response header will contain - * - * - * 
-     * {
-     *    "HTTP-Version": "HTTP/1.1" (for example),
-     *    "Status-Code": "200" (for example),
-     *    "Reason-Phrase": "OK" (for example)
-     * }
-     *
- * - * In addition, the other parameters in the header will be captured, using the HTTP field names as JSON names, so - * that - * - * - * 
-     *    Date: Sun, 26 May 2002 18:06:04 GMT
-     *    Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
-     *    Cache-Control: no-cache
-     *
- * - * become - * - * - * 
-     * {...
-     *    Date: "Sun, 26 May 2002 18:06:04 GMT",
-     *    Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
-     *    "Cache-Control": "no-cache",
-     * ...}
-     *
- * - * It does no further checking or conversion. It does not parse dates. It does not do '%' transforms on URLs. - * - * @param string An HTTP header string. - * - * @return A JSONObject containing the elements and attributes of the XML string. - * - * @throws JSONException - */ public static JSONObject toJSONObject(final String string) throws JSONException { final JSONObject jo = new JSONObject(); final HTTPTokener x = new HTTPTokener(string); diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/json/JSONML.java b/PlotSquared/src/main/java/com/intellectualcrafters/json/JSONML.java index ac419e1a2..c63a5670b 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/json/JSONML.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/json/JSONML.java @@ -188,7 +188,6 @@ public class JSONML { * Convert a well-formed (but not necessarily valid) XML string into a JSONArray using the JsonML transform. Each * XML tag is represented as a JSONArray in which the first element is the tag name. If the tag has attributes, then * the second element will be JSONObject containing the name/value pairs. If the tag contains children, then strings - * and JSONArrays will represent the child tags. Comments, prologs, DTDs, and <[ [ ]]> are ignored. * * @param string The source string. * diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/json/JSONObject.java b/PlotSquared/src/main/java/com/intellectualcrafters/json/JSONObject.java index 408a2ec91..3cac13db7 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/json/JSONObject.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/json/JSONObject.java @@ -343,7 +343,6 @@ public class JSONObject { /** * Produce a string in double quotes with backslash sequences in all the right places. A backslash will be inserted - * within '. - */ public static final Character GT = '>'; - /** - * The Character '<'. - */ public static final Character LT = '<'; - /** - * The Character '?'. - */ public static final Character QUEST = '?'; - /** - * The Character '"'. - */ public static final Character QUOT = '"'; - /** - * The Character '/'. - */ public static final Character SLASH = '/'; - /** - * Replace special characters with XML escapes: - * - * - * 
-     * & (ampersand) is replaced by &amp;
-     * < (less than) is replaced by &lt;
-     * > (greater than) is replaced by &gt;
-     * " (double quote) is replaced by &quot;
-     *
- * - * @param string The string to be escaped. - * - * @return The escaped string. - */ public static String escape(final String string) { final StringBuilder sb = new StringBuilder(string.length()); for (int i = 0, length = string.length(); i < length; i++) { @@ -300,20 +258,6 @@ public class XML { return string; } - /** - * Convert a well-formed (but not necessarily valid) XML string into a JSONObject. Some information may be lost in - * this transformation because JSON is a data format and XML is a document format. XML uses elements, attributes, - * and content text, while JSON uses unordered collections of name/value pairs and arrays of values. JSON does not - * does not like to distinguish between elements and attributes. Sequences of similar elements are represented as - * JSONArrays. Content text may be placed in a "content" member. Comments, prologs, DTDs, and <[ [ - * ]]> are ignored. - * - * @param string The source string. - * - * @return A JSONObject containing the structured data from the XML string. - * - * @throws JSONException - */ public static JSONObject toJSONObject(final String string) throws JSONException { final JSONObject jo = new JSONObject(); final XMLTokener x = new XMLTokener(string); diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/json/XMLTokener.java b/PlotSquared/src/main/java/com/intellectualcrafters/json/XMLTokener.java index d0e39ad36..94edd5792 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/json/XMLTokener.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/json/XMLTokener.java @@ -55,10 +55,10 @@ public class XMLTokener extends JSONTokener { } /** - * Get the next XML outer token, trimming whitespace. There are two kinds of tokens: the '<' character which begins + * Get the next XML outer token, trimming whitespace. There are two kinds of tokens: the '<' character which begins * a markup tag, and the content text between markup tags. * - * @return A string, or a '<' Character, or null if there is no more source text. + * @return A string, or a '<' Character, or null if there is no more source text. * * @throws JSONException */ @@ -90,7 +90,7 @@ public class XMLTokener extends JSONTokener { } /** - * Return the next entity. These entities are translated to Characters: & ' > < + * Return the next entity. These entities are translated to Characters: & " > < * ". * * @param ampersand An ampersand character. @@ -119,7 +119,7 @@ public class XMLTokener extends JSONTokener { /** * Returns the next XML meta token. This is used for skipping over and structures. * - * @return Syntax characters (< > / = ! ?) are returned as Character, and strings and names are + * @return Syntax characters (< > / = ! ?) are returned as Character, and strings and names are * returned as Boolean. We don't care what the values actually are. * * @throws JSONException If a string is not properly closed or if the XML is badly structured. @@ -182,7 +182,7 @@ public class XMLTokener extends JSONTokener { /** * Get the next XML Token. These tokens are found inside of angle brackets. It may be one of these characters: - * / > = ! ? or it may be a string wrapped in single quotes or double quotes, or it may be a name. + * / >= ! ? or it may be a string wrapped in single quotes or double quotes, or it may be a name. * * @return a String or a Character. * diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/plot/api/PlotAPI.java b/PlotSquared/src/main/java/com/intellectualcrafters/plot/api/PlotAPI.java index 5e207db66..ba67693d7 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/plot/api/PlotAPI.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/plot/api/PlotAPI.java @@ -201,7 +201,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper; } /** - * Do not use this. Instead use FlagManager. in your code. + * Do not use this. Instead use FlagManager.[method] in your code. * - Flag related stuff * * @return FlagManager @@ -214,7 +214,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper; } /** - * Do not use this. Instead use ClusterManager. in your code. + * Do not use this. Instead use ClusterManager.[method] in your code. * - Plot cluster related stuff * * @return ClusterManager @@ -227,7 +227,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper; } /** - * Do not use this. Instead use MainUtil. in your code. + * Do not use this. Instead use MainUtil.[method] in your code. * - Basic plot management stuff * * @return MainUtil @@ -240,7 +240,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper; } /** - * Do not use this. Instead use Permissions. in your code. + * Do not use this. Instead use Permissions.[method] in your code. * - Basic permission management stuff * * @return MainUtil @@ -264,7 +264,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper; } /** - * Use C. instead + * Use C.[caption] instead * * @return C * @@ -293,7 +293,7 @@ import com.intellectualcrafters.plot.uuid.UUIDWrapper; * Get the plot manager for a world. - Contains useful low level methods for plot merging, clearing, and * tessellation * - * @param world Plot World + * @param world * * @return PlotManager * diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/AbstractFlag.java b/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/AbstractFlag.java index f204be4ae..0eec59d6c 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/AbstractFlag.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/AbstractFlag.java @@ -38,7 +38,7 @@ public class AbstractFlag { /** * AbstractFlag is a parameter used in creating a new Flag
- * The key must be alphabetical characters and <= 16 characters in length + * The key must be alphabetical characters and <= 16 characters in length * @param key */ public AbstractFlag(final String key, final FlagValue value) { diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/Flag.java b/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/Flag.java index e5eab6261..c31c4456b 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/Flag.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/Flag.java @@ -31,7 +31,7 @@ public class Flag { * player, you need to register it with PlotSquared. * * @param key AbstractFlag - * @param value Value must be alphanumerical (can have spaces) and be <= 48 characters + * @param value Value must be alphanumerical (can have spaces) and be <= 48 characters * * @throws IllegalArgumentException if you provide inadequate inputs */ diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/FlagManager.java b/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/FlagManager.java index 8c6e0238a..2ac43e608 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/FlagManager.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/plot/flag/FlagManager.java @@ -171,7 +171,7 @@ public class FlagManager { /** * * @param plot - * @return Set + * @return set of flags */ public static Set getPlotFlags(final Plot plot) { return getSettingFlags(plot.world, plot.settings); diff --git a/PlotSquared/src/main/java/com/intellectualcrafters/plot/object/Plot.java b/PlotSquared/src/main/java/com/intellectualcrafters/plot/object/Plot.java index d75142f14..8abad98ba 100644 --- a/PlotSquared/src/main/java/com/intellectualcrafters/plot/object/Plot.java +++ b/PlotSquared/src/main/java/com/intellectualcrafters/plot/object/Plot.java @@ -283,8 +283,8 @@ public class Plot implements Cloneable { /** * Get the plot hashcode * - * @return integer. You can easily make this a character array
xI = c[0] x = c[1 -> xI...] yI = c[xI ... + 1] y - * = c[xI ... + 2 -> yI ...] + * @return integer. You can easily make this a character array
xI = c[0] x = c[1 -> xI...] yI = c[xI ... + 1] y + * = c[xI ... + 2 -> yI ...] */ @Override public int hashCode() {