fix javadoc errors that prevent compilation in Eclipse

This commit is contained in:
John Aylward 2021-07-22 22:54:46 -04:00
parent 449ec8745e
commit 4e0faebe62
5 changed files with 14 additions and 17 deletions

View File

@ -1639,9 +1639,6 @@ public class JSONObject {
* implementations and interfaces has the annotation. Returns the depth of the * implementations and interfaces has the annotation. Returns the depth of the
* annotation in the hierarchy. * annotation in the hierarchy.
* *
* @param <A>
* type of the annotation
*
* @param m * @param m
* method to check * method to check
* @param annotationClass * @param annotationClass

View File

@ -188,7 +188,7 @@ public class JSONPointer {
} }
/** /**
* @see https://tools.ietf.org/html/rfc6901#section-3 * @see <a href="https://tools.ietf.org/html/rfc6901#section-3">rfc6901 section 3</a>
*/ */
private static String unescape(String token) { private static String unescape(String token) {
return token.replace("~1", "/").replace("~0", "~"); return token.replace("~1", "/").replace("~0", "~");
@ -268,7 +268,7 @@ public class JSONPointer {
* @param token the JSONPointer segment value to be escaped * @param token the JSONPointer segment value to be escaped
* @return the escaped value for the token * @return the escaped value for the token
* *
* @see https://tools.ietf.org/html/rfc6901#section-3 * @see <a href="https://tools.ietf.org/html/rfc6901#section-3">rfc6901 section 3</a>
*/ */
private static String escape(String token) { private static String escape(String token) {
return token.replace("~", "~0") return token.replace("~", "~0")

View File

@ -182,7 +182,7 @@ public class XMLParserConfiguration {
* When parsing the XML into JSON, specifies if values should be kept as strings (<code>true</code>), or if * When parsing the XML into JSON, specifies if values should be kept as strings (<code>true</code>), or if
* they should try to be guessed into JSON values (numeric, boolean, string) * they should try to be guessed into JSON values (numeric, boolean, string)
* *
* @return The {@link #keepStrings} configuration value. * @return The <code>keepStrings</code> configuration value.
*/ */
public boolean isKeepStrings() { public boolean isKeepStrings() {
return this.keepStrings; return this.keepStrings;
@ -193,7 +193,7 @@ public class XMLParserConfiguration {
* they should try to be guessed into JSON values (numeric, boolean, string) * they should try to be guessed into JSON values (numeric, boolean, string)
* *
* @param newVal * @param newVal
* new value to use for the {@link #keepStrings} configuration option. * new value to use for the <code>keepStrings</code> configuration option.
* *
* @return The existing configuration will not be modified. A new configuration is returned. * @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 <code>null</code> to indicate no CDATA * been the value "content" but can be changed. Use <code>null</code> to indicate no CDATA
* processing. * processing.
* *
* @return The {@link #cDataTagName} configuration value. * @return The <code>cDataTagName</code> configuration value.
*/ */
public String getcDataTagName() { public String getcDataTagName() {
return this.cDataTagName; return this.cDataTagName;
@ -220,7 +220,7 @@ public class XMLParserConfiguration {
* processing. * processing.
* *
* @param newVal * @param newVal
* new value to use for the {@link #cDataTagName} configuration option. * new value to use for the <code>cDataTagName</code> configuration option.
* *
* @return The existing configuration will not be modified. A new configuration is returned. * @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(<code>false</code>), or they should be converted to * should be kept as attribute(<code>false</code>), or they should be converted to
* <code>null</code>(<code>true</code>) * <code>null</code>(<code>true</code>)
* *
* @return The {@link #convertNilAttributeToNull} configuration value. * @return The <code>convertNilAttributeToNull</code> configuration value.
*/ */
public boolean isConvertNilAttributeToNull() { public boolean isConvertNilAttributeToNull() {
return this.convertNilAttributeToNull; return this.convertNilAttributeToNull;
@ -247,7 +247,7 @@ public class XMLParserConfiguration {
* <code>null</code>(<code>true</code>) * <code>null</code>(<code>true</code>)
* *
* @param newVal * @param newVal
* new value to use for the {@link #convertNilAttributeToNull} configuration option. * new value to use for the <code>convertNilAttributeToNull</code> configuration option.
* *
* @return The existing configuration will not be modified. A new configuration is returned. * @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 * will be converted to target type defined to client in this configuration
* {@code Map<String, XMLXsiTypeConverter<?>>} to parse values with attribute * {@code Map<String, XMLXsiTypeConverter<?>>} to parse values with attribute
* xsi:type="integer" as integer, xsi:type="string" as string * xsi:type="integer" as integer, xsi:type="string" as string
* @return {@link #xsiTypeMap} unmodifiable configuration map. * @return <code>xsiTypeMap</code> unmodifiable configuration map.
*/ */
public Map<String, XMLXsiTypeConverter<?>> getXsiTypeMap() { public Map<String, XMLXsiTypeConverter<?>> getXsiTypeMap() {
return this.xsiTypeMap; return this.xsiTypeMap;

View File

@ -120,7 +120,7 @@ public class JSONPointerTest {
/** /**
* We pass backslashes as-is * We pass backslashes as-is
* *
* @see https://tools.ietf.org/html/rfc6901#section-3 * @see <a href="https://tools.ietf.org/html/rfc6901#section-3">rfc6901 section 3</a>
*/ */
@Test @Test
public void backslashHandling() { public void backslashHandling() {
@ -130,7 +130,7 @@ public class JSONPointerTest {
/** /**
* We pass quotations as-is * We pass quotations as-is
* *
* @see https://tools.ietf.org/html/rfc6901#section-3 * @see <a href="https://tools.ietf.org/html/rfc6901#section-3">rfc6901 section 3</a>
*/ */
@Test @Test
public void quotationHandling() { public void quotationHandling() {

View File

@ -8,7 +8,7 @@ import java.io.IOException;
import java.lang.reflect.InvocationTargetException; 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 * @author John Aylward
*/ */