From 4e0faebe62ebe4d067d6fd97530a569d672ab524 Mon Sep 17 00:00:00 2001 From: John Aylward Date: Thu, 22 Jul 2021 22:54:46 -0400 Subject: [PATCH] fix javadoc errors that prevent compilation in Eclipse --- src/main/java/org/json/JSONObject.java | 3 --- src/main/java/org/json/JSONPointer.java | 4 ++-- .../java/org/json/XMLParserConfiguration.java | 18 +++++++++--------- .../java/org/json/junit/JSONPointerTest.java | 4 ++-- .../org/json/junit/data/ExceptionalBean.java | 2 +- 5 files changed, 14 insertions(+), 17 deletions(-) diff --git a/src/main/java/org/json/JSONObject.java b/src/main/java/org/json/JSONObject.java index 97a6df8..a8cfbb7 100644 --- a/src/main/java/org/json/JSONObject.java +++ b/src/main/java/org/json/JSONObject.java @@ -1639,9 +1639,6 @@ public class JSONObject { * implementations and interfaces has the annotation. Returns the depth of the * annotation in the hierarchy. * - * @param - * type of the annotation - * * @param m * method to check * @param annotationClass diff --git a/src/main/java/org/json/JSONPointer.java b/src/main/java/org/json/JSONPointer.java index a3d1c1a..f1f7f33 100644 --- a/src/main/java/org/json/JSONPointer.java +++ b/src/main/java/org/json/JSONPointer.java @@ -188,7 +188,7 @@ public class JSONPointer { } /** - * @see https://tools.ietf.org/html/rfc6901#section-3 + * @see rfc6901 section 3 */ private static String unescape(String token) { return token.replace("~1", "/").replace("~0", "~"); @@ -268,7 +268,7 @@ public class JSONPointer { * @param token the JSONPointer segment value to be escaped * @return the escaped value for the token * - * @see https://tools.ietf.org/html/rfc6901#section-3 + * @see rfc6901 section 3 */ private static String escape(String token) { return token.replace("~", "~0") diff --git a/src/main/java/org/json/XMLParserConfiguration.java b/src/main/java/org/json/XMLParserConfiguration.java index b9e752c..af3093b 100644 --- a/src/main/java/org/json/XMLParserConfiguration.java +++ b/src/main/java/org/json/XMLParserConfiguration.java @@ -94,7 +94,7 @@ public class XMLParserConfiguration { * Configure the parser string processing to try and convert XML values to JSON values and * use the passed CDATA Tag Name the processing value. Pass null to * disable CDATA processing - * @param cDataTagNamenull to disable CDATA processing. Any other value + * @param cDataTagName null to disable CDATA processing. Any other value * to use that value as the JSONObject key name to process as CDATA. * @deprecated This constructor has been deprecated in favor of using the new builder * pattern for the configuration. @@ -109,7 +109,7 @@ public class XMLParserConfiguration { * Configure the parser to use custom settings. * @param keepStrings true to parse all values as string. * false to try and convert XML string values into a JSON value. - * @param cDataTagNamenull to disable CDATA processing. Any other value + * @param cDataTagName null to disable CDATA processing. Any other value * to use that value as the JSONObject key name to process as CDATA. * @deprecated This constructor has been deprecated in favor of using the new builder * pattern for the configuration. @@ -182,7 +182,7 @@ public class XMLParserConfiguration { * When parsing the XML into JSON, specifies if values should be kept as strings (true), or if * they should try to be guessed into JSON values (numeric, boolean, string) * - * @return The {@link #keepStrings} configuration value. + * @return The keepStrings configuration value. */ public boolean isKeepStrings() { return this.keepStrings; @@ -193,7 +193,7 @@ public class XMLParserConfiguration { * they should try to be guessed into JSON values (numeric, boolean, string) * * @param newVal - * new value to use for the {@link #keepStrings} configuration option. + * new value to use for the keepStrings configuration option. * * @return The existing configuration will not be modified. A new configuration is returned. */ @@ -208,7 +208,7 @@ public class XMLParserConfiguration { * been the value "content" but can be changed. Use null to indicate no CDATA * processing. * - * @return The {@link #cDataTagName} configuration value. + * @return The cDataTagName configuration value. */ public String getcDataTagName() { return this.cDataTagName; @@ -220,7 +220,7 @@ public class XMLParserConfiguration { * processing. * * @param newVal - * new value to use for the {@link #cDataTagName} configuration option. + * new value to use for the cDataTagName configuration option. * * @return The existing configuration will not be modified. A new configuration is returned. */ @@ -235,7 +235,7 @@ public class XMLParserConfiguration { * should be kept as attribute(false), or they should be converted to * null(true) * - * @return The {@link #convertNilAttributeToNull} configuration value. + * @return The convertNilAttributeToNull configuration value. */ public boolean isConvertNilAttributeToNull() { return this.convertNilAttributeToNull; @@ -247,7 +247,7 @@ public class XMLParserConfiguration { * null(true) * * @param newVal - * new value to use for the {@link #convertNilAttributeToNull} configuration option. + * new value to use for the convertNilAttributeToNull configuration option. * * @return The existing configuration will not be modified. A new configuration is returned. */ @@ -262,7 +262,7 @@ public class XMLParserConfiguration { * will be converted to target type defined to client in this configuration * {@code Map>} to parse values with attribute * xsi:type="integer" as integer, xsi:type="string" as string - * @return {@link #xsiTypeMap} unmodifiable configuration map. + * @return xsiTypeMap unmodifiable configuration map. */ public Map> getXsiTypeMap() { return this.xsiTypeMap; diff --git a/src/test/java/org/json/junit/JSONPointerTest.java b/src/test/java/org/json/junit/JSONPointerTest.java index f1b9684..a72af3d 100644 --- a/src/test/java/org/json/junit/JSONPointerTest.java +++ b/src/test/java/org/json/junit/JSONPointerTest.java @@ -120,7 +120,7 @@ public class JSONPointerTest { /** * We pass backslashes as-is * - * @see https://tools.ietf.org/html/rfc6901#section-3 + * @see rfc6901 section 3 */ @Test public void backslashHandling() { @@ -130,7 +130,7 @@ public class JSONPointerTest { /** * We pass quotations as-is * - * @see https://tools.ietf.org/html/rfc6901#section-3 + * @see rfc6901 section 3 */ @Test public void quotationHandling() { diff --git a/src/test/java/org/json/junit/data/ExceptionalBean.java b/src/test/java/org/json/junit/data/ExceptionalBean.java index 72d6c0c..91067b8 100644 --- a/src/test/java/org/json/junit/data/ExceptionalBean.java +++ b/src/test/java/org/json/junit/data/ExceptionalBean.java @@ -8,7 +8,7 @@ import java.io.IOException; import java.lang.reflect.InvocationTargetException; /** - * Object for testing the exception handling in {@link JSONObject#populateMap}. + * Object for testing the exception handling in {@link org.json.JSONObject#populateMap}. * * @author John Aylward */