litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

JavaDoc changes required to prevent the release process breaking

Browse source
This commit is contained in:
Graham Triggs 2016-06-23 20:08:14 +01:00
parent abac59cd18
commit 4349724207
124 changed files with 359 additions and 480 deletions
Download patch file Download diff file Expand all files Collapse all files

6
api/src/main/java/org/json/Cookie.java
View file

@ -140,11 +140,11 @@ public class Cookie {
}
/**
* Convert <code>%</code><i>hh</i> sequences to single characters, and
* Convert {@code %}<i>hh</i> sequences to single characters, and
* convert plus to space.
* @param s A string that may contain
* <code>+</code>&nbsp;<small>(plus)</small> and
* <code>%</code><i>hh</i> sequences.
* {@code +}&nbsp;<small>(plus)</small> and
* {@code %}<i>hh</i> sequences.
* @return The unescaped string.
*/
public static String unescape(String s) {

16
api/src/main/java/org/json/HTTP.java
View file

@ -39,28 +39,28 @@ public class HTTP {
/**
* Convert an HTTP header string into a JSONObject. It can be a request
* header or a response header. A request header will contain
* <pre>{
* {@code {
* Method: "POST" (for example),
* "Request-URI": "/" (for example),
* "HTTP-Version": "HTTP/1.1" (for example)
* }</pre>
* }}
* A response header will contain
* <pre>{
* {@code {
* "HTTP-Version": "HTTP/1.1" (for example),
* "Status-Code": "200" (for example),
* "Reason-Phrase": "OK" (for example)
* }</pre>
* }}
* In addition, the other parameters in the header will be captured, using
* the HTTP field names as JSON names, so that <pre>
* the HTTP field names as JSON names, so that {@code
* Date: Sun, 26 May 2002 18:06:04 GMT
* Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
* Cache-Control: no-cache</pre>
* Cache-Control: no-cache}
* become
* <pre>{...
* {@code {...
* Date: "Sun, 26 May 2002 18:06:04 GMT",
* Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
* "Cache-Control": "no-cache",
* ...}</pre>
* ...}}
* 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.

54
api/src/main/java/org/json/JSONArray.java
View file

@ -33,46 +33,46 @@ import java.util.Map;
/**
* A JSONArray is an ordered sequence of values. Its external text form is a
* string wrapped in square brackets with commas separating the values. The
* internal form is an object having <code>get</code> and <code>opt</code>
* methods for accessing the values by index, and <code>put</code> methods for
* internal form is an object having {@code get} and {@code opt}
* methods for accessing the values by index, and {@code put} methods for
* adding or replacing values. The values can be any of these types:
* <code>Boolean</code>, <code>JSONArray</code>, <code>JSONObject</code>,
* <code>Number</code>, <code>String</code>, or the
* <code>JSONObject.NULL object</code>.
* {@code Boolean}, {@code JSONArray}, {@code JSONObject},
* {@code Number}, {@code String}, or the
* {@code JSONObject.NULL object}.
* <p>
* The constructor can convert a JSON text into a Java object. The
* <code>toString</code> method converts to JSON text.
* {@code toString} method converts to JSON text.
* <p>
* A <code>get</code> method returns a value if one can be found, and throws an
* exception if one cannot be found. An <code>opt</code> method returns a
* A {@code get} method returns a value if one can be found, and throws an
* exception if one cannot be found. An {@code opt} method returns a
* default value instead of throwing an exception, and so is useful for
* obtaining optional values.
* <p>
* The generic <code>get()</code> and <code>opt()</code> methods return an
* The generic {@code get()} and {@code opt()} methods return an
* object which you can cast or query for type. There are also typed
* <code>get</code> and <code>opt</code> methods that do type checking and type
* {@code get} and {@code opt} methods that do type checking and type
* coersion for you.
* <p>
* The texts produced by the <code>toString</code> methods strictly conform to
* The texts produced by the {@code toString} methods strictly conform to
* JSON syntax rules. The constructors are more forgiving in the texts they will
* accept:
* <ul>
* <li>An extra <code>,</code>&nbsp;<small>(comma)</small> may appear just
* <li>An extra {@code ,}&nbsp;<small>(comma)</small> may appear just
* before the closing bracket.</li>
* <li>The <code>null</code> value will be inserted when there
* is <code>,</code>&nbsp;<small>(comma)</small> elision.</li>
* <li>Strings may be quoted with <code>'</code>&nbsp;<small>(single
* <li>The {@code null} value will be inserted when there
* is {@code ,}&nbsp;<small>(comma)</small> elision.</li>
* <li>Strings may be quoted with {@code '}&nbsp;<small>(single
* quote)</small>.</li>
* <li>Strings do not need to be quoted at all if they do not begin with a quote
* or single quote, and if they do not contain leading or trailing spaces,
* and if they do not contain any of these characters:
* <code>{ } [ ] / \ : , = ; #</code> and if they do not look like numbers
* and if they are not the reserved words <code>true</code>,
* <code>false</code>, or <code>null</code>.</li>
* <li>Values can be separated by <code>;</code> <small>(semicolon)</small> as
* well as by <code>,</code> <small>(comma)</small>.</li>
* <li>Numbers may have the <code>0-</code> <small>(octal)</small> or
* <code>0x-</code> <small>(hex)</small> prefix.</li>
* {@code { } [ ] / \ : , = ; #} and if they do not look like numbers
* and if they are not the reserved words {@code true},
* {@code false}, or {@code null}.</li>
* <li>Values can be separated by {@code ;} <small>(semicolon)</small> as
* well as by {@code ,} <small>(comma)</small>.</li>
* <li>Numbers may have the {@code 0-} <small>(octal)</small> or
* {@code 0x-} <small>(hex)</small> prefix.</li>
* <li>Comments written in the slashshlash, slashstar, and hash conventions
* will be ignored.</li>
* </ul>
@ -138,8 +138,8 @@ public class JSONArray {
/**
* Construct a JSONArray from a source sJSON text.
* @param string A string that begins with
* <code>[</code>&nbsp;<small>(left bracket)</small>
* and ends with <code>]</code>&nbsp;<small>(right bracket)</small>.
* {@code [}&nbsp;<small>(left bracket)</small>
* and ends with {@code ]}&nbsp;<small>(right bracket)</small>.
* @throws JSONException If there is a syntax error.
*/
public JSONArray(String string) throws JSONException {
@ -307,7 +307,7 @@ public class JSONArray {
/**
* Make a string from the contents of this JSONArray. The
* <code>separator</code> string is inserted between each element.
* {@code separator} string is inserted between each element.
* Warning: This method assumes that the data structure is acyclical.
* @param separator A string that will be inserted between the elements.
* @return a string.
@ -780,8 +780,8 @@ public class JSONArray {
* indentation.
* @return a printable, displayable, transmittable
* representation of the object, beginning
* with <code>[</code>&nbsp;<small>(left bracket)</small> and ending
* with <code>]</code>&nbsp;<small>(right bracket)</small>.
* with {@code [}&nbsp;<small>(left bracket)</small> and ending
* with {@code ]}&nbsp;<small>(right bracket)</small>.
* @throws JSONException
*/
public String toString(int indentFactor) throws JSONException {

80
api/src/main/java/org/json/JSONObject.java
View file

@ -36,49 +36,49 @@ import java.io.Writer;
* A JSONObject is an unordered collection of name/value pairs. Its
* external form is a string wrapped in curly braces with colons between the
* names and values, and commas between the values and names. The internal form
* is an object having <code>get</code> and <code>opt</code> methods for
* accessing the values by name, and <code>put</code> methods for adding or
* is an object having {@code get} and {@code opt} methods for
* accessing the values by name, and {@code put} methods for adding or
* replacing values by name. The values can be any of these types:
* <code>Boolean</code>, <code>JSONArray</code>, <code>JSONObject</code>,
* <code>Number</code>, <code>String</code>, or the <code>JSONObject.NULL</code>
* {@code Boolean}, {@code JSONArray}, {@code JSONObject},
* {@code Number}, {@code String}, or the {@code JSONObject.NULL}
* object. A JSONObject constructor can be used to convert an external form
* JSON text into an internal form whose values can be retrieved with the
* <code>get</code> and <code>opt</code> methods, or to convert values into a
* JSON text using the <code>put</code> and <code>toString</code> methods.
* A <code>get</code> method returns a value if one can be found, and throws an
* exception if one cannot be found. An <code>opt</code> method returns a
* {@code get} and {@code opt} methods, or to convert values into a
* JSON text using the {@code put} and {@code toString} methods.
* A {@code get} method returns a value if one can be found, and throws an
* exception if one cannot be found. An {@code opt} method returns a
* default value instead of throwing an exception, and so is useful for
* obtaining optional values.
* <p>
* The generic <code>get()</code> and <code>opt()</code> methods return an
* The generic {@code get()} and {@code opt()} methods return an
* object, which you can cast or query for type. There are also typed
* <code>get</code> and <code>opt</code> methods that do type checking and type
* {@code get} and {@code opt} methods that do type checking and type
* coersion for you.
* <p>
* The <code>put</code> methods adds values to an object. For example, <pre>
* The {@code put} methods adds values to an object. For example, <pre>
* myString = new JSONObject().put("JSON", "Hello, World!").toString();</pre>
* produces the string <code>{"JSON": "Hello, World"}</code>.
* produces the string {@code {"JSON": "Hello, World"}}.
* <p>
* The texts produced by the <code>toString</code> methods strictly conform to
* The texts produced by the {@code toString} methods strictly conform to
* the JSON sysntax rules.
* The constructors are more forgiving in the texts they will accept:
* <ul>
* <li>An extra <code>,</code>&nbsp;<small>(comma)</small> may appear just
* <li>An extra {@code ,}&nbsp;<small>(comma)</small> may appear just
* before the closing brace.</li>
* <li>Strings may be quoted with <code>'</code>&nbsp;<small>(single
* <li>Strings may be quoted with {@code '}&nbsp;<small>(single
* quote)</small>.</li>
* <li>Strings do not need to be quoted at all if they do not begin with a quote
* or single quote, and if they do not contain leading or trailing spaces,
* and if they do not contain any of these characters:
* <code>{ } [ ] / \ : , = ; #</code> and if they do not look like numbers
* and if they are not the reserved words <code>true</code>,
* <code>false</code>, or <code>null</code>.</li>
* <li>Keys can be followed by <code>=</code> or <code>=></code> as well as
* by <code>:</code>.</li>
* <li>Values can be followed by <code>;</code> <small>(semicolon)</small> as
* well as by <code>,</code> <small>(comma)</small>.</li>
* <li>Numbers may have the <code>0-</code> <small>(octal)</small> or
* <code>0x-</code> <small>(hex)</small> prefix.</li>
* {@code { } [ ] / \ : , = ; #} and if they do not look like numbers
* and if they are not the reserved words {@code true},
* {@code false}, or {@code null}.</li>
* <li>Keys can be followed by {@code =} or {@code =>} as well as
* by {@code :}.</li>
* <li>Values can be followed by {@code ;} <small>(semicolon)</small> as
* well as by {@code ,} <small>(comma)</small>.</li>
* <li>Numbers may have the {@code 0-} <small>(octal)</small> or
* {@code 0x-} <small>(hex)</small> prefix.</li>
* <li>Comments written in the slashshlash, slashstar, and hash conventions
* will be ignored.</li>
* </ul>
@ -133,9 +133,9 @@ public class JSONObject {
/**
* It is sometimes more convenient and less ambiguous to have a
* <code>NULL</code> object than to use Java's <code>null</code> value.
* <code>JSONObject.NULL.equals(null)</code> returns <code>true</code>.
* <code>JSONObject.NULL.toString()</code> returns <code>"null"</code>.
* {@code NULL} object than to use Java's {@code null} value.
* {@code JSONObject.NULL.equals(null)} returns {@code true}.
* {@code JSONObject.NULL.toString()} returns {@code "null"}.
*/
public static final Object NULL = new Null();
@ -267,8 +267,8 @@ public class JSONObject {
* Construct a JSONObject from a string.
* This is the most commonly used JSONObject constructor.
* @param string A string beginning
* with <code>{</code>&nbsp;<small>(left brace)</small> and ending
* with <code>}</code>&nbsp;<small>(right brace)</small>.
* with {@code {}&nbsp;<small>(left brace)</small> and ending
* with {@code }}&nbsp;<small>(right brace)</small>.
* @exception JSONException If there is a syntax error in the source string.
*/
public JSONObject(String string) throws JSONException {
@ -908,7 +908,7 @@ public class JSONObject {
/**
* Produce a string in double quotes with backslash sequences in all the
* right places. A backslash will be inserted within </, allowing JSON
* right places. A backslash will be inserted, allowing JSON
* text to be delivered in HTML. In JSON text, a string cannot contain a
* control character or an unescaped quote or backslash.
* @param string A String
@ -1031,8 +1031,8 @@ public class JSONObject {
*
* @return a printable, displayable, portable, transmittable
* representation of the object, beginning
* with <code>{</code>&nbsp;<small>(left brace)</small> and ending
* with <code>}</code>&nbsp;<small>(right brace)</small>.
* with {@code {}&nbsp;<small>(left brace)</small> and ending
* with {@code }}&nbsp;<small>(right brace)</small>.
*/
public String toString() {
try {
@ -1064,8 +1064,8 @@ public class JSONObject {
* indentation.
* @return a printable, displayable, portable, transmittable
* representation of the object, beginning
* with <code>{</code>&nbsp;<small>(left brace)</small> and ending
* with <code>}</code>&nbsp;<small>(right brace)</small>.
* with {@code {}&nbsp;<small>(left brace)</small> and ending
* with {@code }}&nbsp;<small>(right brace)</small>.
* @throws JSONException If the object contains an invalid number.
*/
public String toString(int indentFactor) throws JSONException {
@ -1082,8 +1082,8 @@ public class JSONObject {
* @param indent The indentation of the top level.
* @return a printable, displayable, transmittable
* representation of the object, beginning
* with <code>{</code>&nbsp;<small>(left brace)</small> and ending
* with <code>}</code>&nbsp;<small>(right brace)</small>.
* with {@code {}&nbsp;<small>(left brace)</small> and ending
* with {@code }}&nbsp;<small>(right brace)</small>.
* @throws JSONException If the object contains an invalid number.
*/
String toString(int indentFactor, int indent) throws JSONException {
@ -1142,8 +1142,8 @@ public class JSONObject {
* @param value The value to be serialized.
* @return a printable, displayable, transmittable
* representation of the object, beginning
* with <code>{</code>&nbsp;<small>(left brace)</small> and ending
* with <code>}</code>&nbsp;<small>(right brace)</small>.
* with {@code {}&nbsp;<small>(left brace)</small> and ending
* with {@code }}&nbsp;<small>(right brace)</small>.
* @throws JSONException If the value is or contains an invalid number.
*/
static String valueToString(Object value) throws JSONException {
@ -1183,8 +1183,8 @@ public class JSONObject {
* @param indent The indentation of the top level.
* @return a printable, displayable, transmittable
* representation of the object, beginning
* with <code>{</code>&nbsp;<small>(left brace)</small> and ending
* with <code>}</code>&nbsp;<small>(right brace)</small>.
* with {@code {}&nbsp;<small>(left brace)</small> and ending
* with {@code }}&nbsp;<small>(right brace)</small>.
* @throws JSONException If the object contains an invalid number.
*/
static String valueToString(Object value, int indentFactor, int indent)

12
api/src/main/java/org/json/JSONString.java
View file

@ -1,15 +1,15 @@
package org.json;
/**
* The <code>JSONString</code> interface allows a <code>toJSONString()</code>
* The {@code JSONString} interface allows a {@code toJSONString()}
* method so that a class can change the behavior of
* <code>JSONObject.toString()</code>, <code>JSONArray.toString()</code>,
* and <code>JSONWriter.value(</code>Object<code>)</code>. The
* <code>toJSONString</code> method will be used instead of the default behavior
* of using the Object's <code>toString()</code> method and quoting the result.
* {@code JSONObject.toString()}, {@code JSONArray.toString()},
* and {@code JSONWriter.value(}Object{@code )}. The
* {@code toJSONString} method will be used instead of the default behavior
* of using the Object's {@code toString()} method and quoting the result.
*/
public interface JSONString {
/**
* The <code>toJSONString</code> method allows a class to produce its own JSON
* The {@code toJSONString} method allows a class to produce its own JSON
* serialization.
*
* @return A strictly syntactically correct JSON text.

18
api/src/main/java/org/json/JSONStringer.java
View file

@ -32,12 +32,12 @@ import java.io.StringWriter;
* added, so the results are ready for transmission or storage. Each instance of
* JSONStringer can produce one JSON text.
* <p>
* A JSONStringer instance provides a <code>value</code> method for appending
* A JSONStringer instance provides a {@code value} method for appending
* values to the
* text, and a <code>key</code>
* method for adding keys before values in objects. There are <code>array</code>
* and <code>endArray</code> methods that make and bound array values, and
* <code>object</code> and <code>endObject</code> methods which make and bound
* text, and a {@code key}
* method for adding keys before values in objects. There are {@code array}
* and {@code endArray} methods that make and bound array values, and
* {@code object} and {@code endObject} methods which make and bound
* object values. All of these methods return the JSONWriter instance,
* permitting cascade style. For example, <pre>
* myString = new JSONStringer()
@ -48,7 +48,7 @@ import java.io.StringWriter;
* .toString();</pre> which produces the string <pre>
* {"JSON":"Hello, World!"}</pre>
* <p>
* The first method called must be <code>array</code> or <code>object</code>.
* The first method called must be {@code array} or {@code object}.
* There are no methods for adding commas or colons. JSONStringer adds them for
* you. Objects and arrays can be nested up to 20 levels deep.
* <p>
@ -66,10 +66,10 @@ public class JSONStringer extends JSONWriter {
/**
* Return the JSON text. This method is used to obtain the product of the
* JSONStringer instance. It will return <code>null</code> if there was a
* JSONStringer instance. It will return {@code null} if there was a
* problem in the construction of the JSON text (such as the calls to
* <code>array</code> were not properly balanced with calls to
* <code>endArray</code>).
* {@code array} were not properly balanced with calls to
* {@code endArray}).
* @return The JSON text.
*/
public String toString() {

4
api/src/main/java/org/json/JSONTokener.java
View file

@ -202,8 +202,8 @@ public class JSONTokener {
* allow strings in single quotes, but an implementation is allowed to
* accept them.
* @param quote The quoting character, either
* <code>"</code>&nbsp;<small>(double quote)</small> or
* <code>'</code>&nbsp;<small>(single quote)</small>.
* {@code "}&nbsp;<small>(double quote)</small> or
* {@code '}&nbsp;<small>(single quote)</small>.
* @return A String.
* @throws JSONException Unterminated string.
*/

28
api/src/main/java/org/json/JSONWriter.java
View file

@ -33,12 +33,12 @@ SOFTWARE.
* added, so the results are ready for transmission or storage. Each instance of
* JSONWriter can produce one JSON text.
* <p>
* A JSONWriter instance provides a <code>value</code> method for appending
* A JSONWriter instance provides a {@code value} method for appending
* values to the
* text, and a <code>key</code>
* method for adding keys before values in objects. There are <code>array</code>
* and <code>endArray</code> methods that make and bound array values, and
* <code>object</code> and <code>endObject</code> methods which make and bound
* text, and a {@code key}
* method for adding keys before values in objects. There are {@code array}
* and {@code endArray} methods that make and bound array values, and
* {@code object} and {@code endObject} methods which make and bound
* object values. All of these methods return the JSONWriter instance,
* permitting a cascade style. For example, <pre>
* new JSONWriter(myWriter)
@ -48,7 +48,7 @@ SOFTWARE.
* .endObject();</pre> which writes <pre>
* {"JSON":"Hello, World!"}</pre>
* <p>
* The first method called must be <code>array</code> or <code>object</code>.
* The first method called must be {@code array} or {@code object}.
* There are no methods for adding commas or colons. JSONWriter adds them for
* you. Objects and arrays can be nested up to 20 levels deep.
* <p>
@ -131,8 +131,8 @@ public class JSONWriter {
/**
* Begin appending a new array. All values until the balancing
* <code>endArray</code> will be appended to this array. The
* <code>endArray</code> method must be called to mark the array's end.
* {@code endArray} will be appended to this array. The
* {@code endArray} method must be called to mark the array's end.
* @return this
* @throws JSONException If the nesting is too deep, or if the object is
* started in the wrong place (for example as a key or after the end of the
@ -172,7 +172,7 @@ public class JSONWriter {
/**
* End an array. This method most be called to balance calls to
* <code>array</code>.
* {@code array}.
* @return this
* @throws JSONException If incorrectly nested.
*/
@ -182,7 +182,7 @@ public class JSONWriter {
/**
* End an object. This method most be called to balance calls to
* <code>object</code>.
* {@code object}.
* @return this
* @throws JSONException If incorrectly nested.
*/
@ -222,8 +222,8 @@ public class JSONWriter {
/**
* Begin appending a new object. All keys and values until the balancing
* <code>endObject</code> will be appended to this object. The
* <code>endObject</code> method must be called to mark the object's end.
* {@code endObject} will be appended to this object. The
* {@code endObject} method must be called to mark the object's end.
* @return this
* @throws JSONException If the nesting is too deep, or if the object is
* started in the wrong place (for example as a key or after the end of the
@ -273,8 +273,8 @@ public class JSONWriter {
/**
* Append either the value <code>true</code> or the value
* <code>false</code>.
* Append either the value {@code true} or the value
* {@code false}.
* @param b A boolean.
* @return this
* @throws JSONException

2
api/src/main/java/org/json/Test.java
View file

@ -13,7 +13,7 @@ public class Test {
/**
* Entry point.
* @param args
* @param args Command line argumments
*/
public static void main(String args[]) {
Iterator it;

28
api/src/main/java/org/json/XML.java
View file

@ -35,40 +35,40 @@ import java.util.Iterator;
*/
public class XML {
/** The Character '&'. */
/* The Character '&'. */
public static final Character AMP = new Character('&');
/** The Character '''. */
/* The Character '''. */
public static final Character APOS = new Character('\'');
/** The Character '!'. */
/* The Character '!'. */
public static final Character BANG = new Character('!');
/** The Character '='. */
/* The Character '='. */
public static final Character EQ = new Character('=');
/** The Character '>'. */
/* The Character '>'. */
public static final Character GT = new Character('>');
/** The Character '<'. */
/* The Character '<'. */
public static final Character LT = new Character('<');
/** The Character '?'. */
/* The Character '?'. */
public static final Character QUEST = new Character('?');
/** The Character '"'. */
/* The Character '"'. */
public static final Character QUOT = new Character('"');
/** The Character '/'. */
/* The Character '/'. */
public static final Character SLASH = new Character('/');
/**
* Replace special characters with XML escapes:
* <pre>
* &amp; <small>(ampersand)</small> is replaced by &amp;amp;
* &lt; <small>(less than)</small> is replaced by &amp;lt;
* &gt; <small>(greater than)</small> is replaced by &amp;gt;
* &quot; <small>(double quote)</small> is replaced by &amp;quot;
* &amp; (ampersand) is replaced by &amp;amp;
* &lt; (less than) is replaced by &amp;lt;
* &gt; (greater than) is replaced by &amp;gt;
* &quot; (double quote) is replaced by &amp;quot;
* </pre>
* @param string The string to be escaped.
* @return The escaped string.
@ -267,7 +267,7 @@ public class XML {
* 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
* <code>&lt;[ [ ]]></code> are ignored.
* {@code &lt;[ [ ]]>} are ignored.
* @param string The source string.
* @return A JSONObject containing the structured data from the XML string.
* @throws JSONException

18
api/src/main/java/org/json/XMLTokener.java
View file

@ -57,8 +57,8 @@ public class XMLTokener extends JSONTokener {
/**
* Get the text in the CDATA block.
* @return The string up to the <code>]]&gt;</code>.
* @throws JSONException If the <code>]]&gt;</code> is not found.
* @return The string up to the {@code ]]&gt;}.
* @throws JSONException If the {@code ]]&gt;} is not found.
*/
public String nextCDATA() throws JSONException {
char c;
@ -82,10 +82,10 @@ public class XMLTokener extends JSONTokener {
/**
* Get the next XML outer token, trimming whitespace. There are two kinds
* of tokens: the '<' character which begins a markup tag, and the content
* 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
* @return A string, or a '&lt;' Character, or null if there is no more
* source text.
* @throws JSONException
*/
@ -119,7 +119,7 @@ public class XMLTokener extends JSONTokener {
/**
* Return the next entity. These entities are translated to Characters:
* <code>&amp; &apos; &gt; &lt; &quot;</code>.
* {@code &amp; &apos; &gt; &lt; &quot;}.
* @param a An ampersand character.
* @return A Character or an entity String if the entity is not recognized.
* @throws JSONException If missing ';' in XML entity.
@ -143,9 +143,9 @@ public class XMLTokener extends JSONTokener {
/**
* Returns the next XML meta token. This is used for skipping over <!...>
* and <?...?> structures.
* @return Syntax characters (<code>< > / = ! ?</code>) are returned as
* Returns the next XML meta token.
*
* @return Syntax characters ({@code < > / = ! ?}) 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
@ -210,7 +210,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: <code>/ > = ! ?</code> or it
* brackets. It may be one of these characters: {@code / > = ! ?} 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.