Skip to content

Commit a43c60c

Browse files
committed
Update javadoc comments
The javadoc CLI included with OpenJDK 8 is OK with literal less than ">" characters in comments. However, OpenJDK 11 is not. So, I changed these all to entities. Also added additional information to a couple of field javadocs. Also cleaned up a couple of broken @link targets.
1 parent 4cde1f6 commit a43c60c

File tree

26 files changed

+97
-65
lines changed

26 files changed

+97
-65
lines changed

example/example1/src/test/java/org/jsonurl/example1/Example1Test.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ void test() throws JsonException, IOException {
2222
JsonArray value = Main.getExampleValue();
2323

2424
//
25-
// turn that into JSON->URL text
25+
// turn that into JSON->URL text
2626
//
2727
JsonUrlStringBuilder text = new JsonUrlStringBuilder();
2828
JsonUrlWriter.write(text, value);
2929
String jsonUrlText = text.build();
3030

3131
//
32-
// parse the JSON->URL text and build a JsonArray
32+
// parse the JSON->URL text and build a JsonArray
3333
//
3434
JsonUrlParser p = new JsonUrlParser();
3535
JsonValue parsedValue = p.parse(jsonUrlText);

module/jsonurl-core/src/main/java/org/jsonurl/JsonUrl.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@
3434
import java.nio.charset.MalformedInputException;
3535

3636
/**
37-
* The reference implementation of JSON->URL.
37+
* The reference implementation of JSON->URL.
3838
*
3939
* <p>This class provides static methods for performing a number of
40-
* actions on JSON->URL text.
40+
* actions on JSON-&gt;URL text.
4141
*
4242
* @author jsonurl.org
4343
* @author David MacCormack
@@ -72,7 +72,7 @@ private static final int percentDecode(
7272
/**
7373
* parse true, false, and null literals.
7474
*
75-
* @return true if the string matches one of the following JSON->URL
75+
* @return true if the string matches one of the following JSON-&gt;URL
7676
* literal values: true, false, null.
7777
*/
7878
@SuppressWarnings("PMD")
@@ -208,7 +208,7 @@ private static final String string(
208208
/**
209209
* parse a literal value.
210210
*
211-
* <p>This will parse a literal value from JSON->URL text and return
211+
* <p>This will parse a literal value from JSON-&gt;URL text and return
212212
* it as a java.lang.String (as opposed to a ValueFactory String).
213213
* It will perform input validation and string literal decoding.
214214
*
@@ -253,7 +253,7 @@ static final String literalToJavaString(
253253
/**
254254
* parse a literal value
255255
*
256-
* <p>This will parse a literal value from JSON->URL text. You may use
256+
* <p>This will parse a literal value from JSON-&gt;URL text. You may use
257257
* {@link org.jsonurl.JsonUrl#parseLiteralLength(CharSequence, int, int)
258258
* parseLiteralLength} to calculate the stop index.
259259
*

module/jsonurl-core/src/main/java/org/jsonurl/JsonUrlStringBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919

2020
/**
21-
* A JsonUrlTextAppender that appends JSON->URL text to a StringBuilder.
21+
* A JsonUrlTextAppender that appends JSON-&gt;URL text to a StringBuilder.
2222
*
2323
* @author jsonurl.org
2424
* @author David MacCormack

module/jsonurl-core/src/main/java/org/jsonurl/JsonUrlTextAppender.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import java.math.BigInteger;
2323

2424
/**
25-
* A JsonTextBuilder that appends JSON->URL text to any Appendable.
25+
* A JsonTextBuilder that appends JSON-&gt;URL text to any Appendable.
2626
* @param <A> Accumulator type
2727
* @param <R> Result type
2828
*
@@ -41,7 +41,7 @@ public abstract class JsonUrlTextAppender<A extends Appendable, R>
4141
/**
4242
* Create a new JsonUrlTextAppender.
4343
*
44-
* @param out JSON->URL text destination
44+
* @param out JSON-&gt;URL text destination
4545
*/
4646
public JsonUrlTextAppender(A out) {
4747
this.out = out;

module/jsonurl-core/src/main/java/org/jsonurl/NumberBuilder.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
import java.math.BigInteger;
2626

2727
/**
28-
* A NumberBuilder implements the builder pattern for JSON->URL numbers.
28+
* A NumberBuilder implements the builder pattern for JSON-&gt;URL numbers.
2929
*
30-
* <p>An instance of this class may be used to parse JSON->URL number
30+
* <p>An instance of this class may be used to parse JSON-&gt;URL number
3131
* values from text and create J2SE8 Numbers.
3232
*
3333
* @author jsonurl.org
@@ -322,7 +322,7 @@ public boolean parse(CharSequence s, int start, int stop) {
322322
}
323323

324324
/**
325-
* Determine if the given CharSequence is a valid JSON->URL number.
325+
* Determine if the given CharSequence is a valid JSON-&gt;URL number.
326326
*
327327
*<p>Convenience for {@link #isNumber(CharSequence, int, int)
328328
* isNumber(s, 0, s.length())}.
@@ -332,12 +332,12 @@ public static boolean isNumber(CharSequence s) {
332332
}
333333

334334
/**
335-
* Determine if the given CharSequence is a valid JSON->URL number.
335+
* Determine if the given CharSequence is a valid JSON-&gt;URL number.
336336
*
337337
* @param s a valid CharSequence
338338
* @param start an index
339339
* @param stop an index
340-
* @return true if the CharSequence is a JSON->URL number
340+
* @return true if the CharSequence is a JSON-&gt;URL number
341341
*/
342342
@SuppressWarnings("PMD")
343343
public static boolean isNumber(CharSequence s, int start, int stop) {

module/jsonurl-core/src/main/java/org/jsonurl/NumberText.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919

2020
/**
21-
* NumberText provides access to a parsed JSON->URL number literal.
21+
* NumberText provides access to a parsed JSON-&gt;URL number literal.
2222
*
2323
* <p>The text of a number is broken down into three parts: integer part,
2424
* decimal part, and exponent. These parts may be accessed via start and stop

module/jsonurl-core/src/main/java/org/jsonurl/ParseException.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919

2020
/**
21-
* An exception that occurs while parsing JSON->URL text.
21+
* An exception that occurs while parsing JSON-&gt;URL text.
2222
*/
2323
public class ParseException extends RuntimeException {
2424

@@ -72,7 +72,7 @@ protected String typeDescription() {
7272
public String toString() {
7373
StringBuilder sb = new StringBuilder(64);
7474

75-
sb.append("JSON->URL ")
75+
sb.append("JSON-&gt;URL ")
7676
.append(typeDescription())
7777
.append(": ")
7878
.append(getMessage());

module/jsonurl-core/src/main/java/org/jsonurl/Parser.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@
3636
import java.util.LinkedList;
3737

3838
/**
39-
* A JSON->URL parser.
39+
* A JSON-&gt;URL parser.
4040
*
41-
* <p>An instance of this class may be used to parse JSON->URL text and
41+
* <p>An instance of this class may be used to parse JSON-&gt;URL text and
4242
* instantiate JVM heap objects. The interface allows you to control the
4343
* types and values of the Objects created.
4444
*
@@ -185,7 +185,7 @@ public V parse(CharSequence s) {
185185
/**
186186
* Parse a character sequence.
187187
*
188-
* <p>Parse the given JSON->URL text and return a typed value.
188+
* <p>Parse the given JSON-&gt;URL text and return a typed value.
189189
* @param s the text to be parsed
190190
* @param off offset of the first character to be parsed
191191
* @param length the number of characters to be parsed

module/jsonurl-core/src/main/java/org/jsonurl/SyntaxException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919

2020
/**
21-
* A syntax error in JSON->URL text.
21+
* A syntax error in JSON-&gt;URL text.
2222
*/
2323
public class SyntaxException extends ParseException {
2424

module/jsonurl-core/src/main/java/org/jsonurl/ValueFactory.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@
2020
/**
2121
* A ValueFactory allows {@link org.jsonurl.Parser Parser}
2222
* to be implementation independent. A ValueFactory provides
23-
* implementation-defined values for JSON->URL
23+
* implementation-defined values for JSON-&gt;URL
2424
* objects, arrays, and literals.
2525
*
26-
* @param V value type (any JSON value)
27-
* @param C composite type (array or object)
28-
* @param AB array builder type
29-
* @param A array type
30-
* @param JB object builder type
31-
* @param J object type
32-
* @param B boolean type
33-
* @param M number type
34-
* @param N null type
35-
* @param S string type
26+
* @param <V> value type (any JSON value)
27+
* @param <C> composite type (array or object)
28+
* @param <ABT> array builder type
29+
* @param <A> array type
30+
* @param <JBT> object builder type
31+
* @param <J> object type
32+
* @param <B> boolean type
33+
* @param <M> number type
34+
* @param <N> null type
35+
* @param <S> string type
3636
*
3737
* @author jsonurl.org
3838
* @author David MacCormack
@@ -110,7 +110,7 @@ default J newObject(J builder) {
110110
*
111111
* <p>This is usually a singleton. It's a value which represents
112112
* the empty composite (i.e. array/object) as defined in the
113-
* JSON->URL spec.
113+
* JSON-&gt;URL spec.
114114
* @return a valid composite instance
115115
*/
116116
public C getEmptyComposite();
@@ -215,7 +215,7 @@ default S getString(String s) {
215215
/**
216216
* Get a number value for the given parsed text.
217217
*
218-
* @param text the parsed text of a JSON->URL number literal
218+
* @param text the parsed text of a JSON-&gt;URL number literal
219219
* @return a number object for the given text
220220
*/
221221
public M getNumber(NumberText text);

0 commit comments

Comments
 (0)