Skip to content
This repository was archived by the owner on Nov 7, 2024. It is now read-only.

Commit 3310625

Browse files
committed
Fix javadoc errors when built with JDK 8
1 parent 3e13c7e commit 3310625

File tree

9 files changed

+18
-21
lines changed

9 files changed

+18
-21
lines changed

api/src/main/java/javax/json/JsonArrayBuilder.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@
6363
* multiple builder instances with the same configuration. This the preferred
6464
* way to create multiple instances.
6565
*
66-
* <a id="JsonArrayBuilderExample1"/>
6766
* The example code below shows how to build a {@code JsonArray} object
6867
* that represents the following JSON array:
6968
*

api/src/main/java/javax/json/JsonNumber.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@
5050
* Implementations may use a {@link BigDecimal} object to store the numeric
5151
* value internally.
5252
* The {@code BigDecimal} object can be constructed from the following types:
53-
* {@link BigDecimal#BigDecimal(int) <code>int</code>},
54-
* {@link BigDecimal#BigDecimal(long) <code>long</code>},
55-
* {@link BigDecimal#BigDecimal(BigInteger) <code>BigInteger</code>},
56-
* {@link BigDecimal#valueOf(double) <code>double</code>}, and
57-
* {@link BigDecimal#BigDecimal(String) <code>String</code>}.
53+
* <code>int</code> {@link BigDecimal#BigDecimal(int)},
54+
* <code>long</code> {@link BigDecimal#BigDecimal(long)},
55+
* <code>BigInteger</code> {@link BigDecimal#BigDecimal(BigInteger)},
56+
* <code>double</code> {@link BigDecimal#valueOf(double)}, and
57+
* <code>String</code> {@link BigDecimal#BigDecimal(String)}.
5858
* Some of the method semantics in this class are defined using the
5959
* {@code BigDecimal} semantics.
6060
*

api/src/main/java/javax/json/JsonObjectBuilder.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@
6464
* multiple builder instances with the same configuration. This the preferred
6565
* way to create multiple instances.
6666
*
67-
* <a id="JsonObjectBuilderExample1"/>
6867
* The example code below shows how to build a {@code JsonObject} model that
6968
* represents the following JSON object:
7069
*
@@ -277,4 +276,4 @@ public interface JsonObjectBuilder {
277276
*/
278277
JsonObject build();
279278

280-
}
279+
}

api/src/main/java/javax/json/JsonReader.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@
5050
* input sources ({@link java.io.InputStream} and {@link java.io.Reader}).
5151
*
5252
* <p>
53-
* <a id="JsonReaderExample1"/>
5453
* The following example demonstrates how to read an empty JSON array from
5554
* a string:
5655
* <pre>

api/src/main/java/javax/json/JsonWriter.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@
5050
* output sources ({@link java.io.OutputStream} and {@link java.io.Writer}).
5151
*
5252
* <p>
53-
* <a id="JsonWriterExample1"/>
5453
* The following example demonstrates how write an empty JSON object:
5554
* <pre>
5655
* <code>
@@ -128,4 +127,4 @@ public interface JsonWriter extends /*Auto*/Closeable {
128127
@Override
129128
void close();
130129

131-
}
130+
}

api/src/main/java/javax/json/stream/JsonGenerator.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,6 @@
9898
* </pre>
9999
*
100100
* {@code JsonGenerator} methods can be chained as in the following example:
101-
* <p>
102-
* <a id="JsonGeneratorExample3"/>
103101
* <pre>
104102
* <code>
105103
* generator
@@ -129,7 +127,6 @@
129127
* </pre>
130128
*
131129
* The example code above generates the following JSON (or equivalent):
132-
* <p>
133130
* <pre>
134131
* <code>
135132
* {
@@ -535,4 +532,4 @@ public interface JsonGenerator extends Flushable, /*Auto*/Closeable {
535532
@Override
536533
void flush();
537534

538-
}
535+
}

api/src/main/java/javax/json/stream/JsonGeneratorFactory.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ public interface JsonGeneratorFactory {
7676
* The generator is configured with the factory configuration.
7777
*
7878
* @param writer i/o writer to which JSON is written
79+
* @return the created JSON generator
7980
*/
8081
JsonGenerator createGenerator(Writer writer);
8182

@@ -85,6 +86,7 @@ public interface JsonGeneratorFactory {
8586
* The generator is configured with the factory's configuration.
8687
*
8788
* @param out i/o stream to which JSON is written
89+
* @return the created JSON generator
8890
*/
8991
JsonGenerator createGenerator(OutputStream out);
9092

@@ -95,6 +97,7 @@ public interface JsonGeneratorFactory {
9597
*
9698
* @param out i/o stream to which JSON is written
9799
* @param charset a charset
100+
* @return the created JSON generator
98101
*/
99102
JsonGenerator createGenerator(OutputStream out, Charset charset);
100103

@@ -109,4 +112,4 @@ public interface JsonGeneratorFactory {
109112
*/
110113
Map<String, ?> getConfigInUse();
111114

112-
}
115+
}

api/src/main/java/javax/json/stream/JsonParser.java

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,6 @@
9797
* </pre>
9898
*
9999
* <p>
100-
* <a id="JsonParserExample2"/>
101-
* <p>
102100
* <b>For example</b>, for the following JSON:
103101
* <pre>
104102
* {
@@ -113,7 +111,6 @@
113111
* <p>calls to the method {@code next()} result in parse events at the specified
114112
* locations below (marked in bold):
115113
*
116-
* <p>
117114
* <pre>
118115
* {<B>START_OBJECT</B>
119116
* "firstName"<B>KEY_NAME</B>: "John"<B>VALUE_STRING</B>, "lastName"<B>KEY_NAME</B>: "Smith"<B>VALUE_STRING</B>, "age"<B>KEY_NAME</B>: 25<B>VALUE_NUMBER</B>,
@@ -124,13 +121,11 @@
124121
* }<B>END_OBJECT</B>
125122
* </pre>
126123
*
127-
* <p>
128124
* The methods {@code next()} and {@code hasNext()} enable iteration over
129125
* parser events to process JSON data. {@code JsonParser} provides get methods
130126
* to obtain the value at the current state of the parser. For example, the
131127
* following code shows how to obtain the value "John" from the JSON above:
132128
*
133-
* <p>
134129
* <pre>
135130
* <code>
136131
* Event event = parser.next(); // START_OBJECT
@@ -222,6 +217,7 @@ enum Event {
222217
* @throws JsonParsingException if the parser encounters invalid JSON
223218
* when advancing to next state.
224219
* @throws java.util.NoSuchElementException if there are no more parsing
220+
* @return the event for the next parsing state
225221
* states.
226222
*/
227223
Event next();

api/src/main/java/javax/json/stream/JsonParserFactory.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ public interface JsonParserFactory {
7777
* Creates a JSON parser from a character stream.
7878
*
7979
* @param reader a i/o reader from which JSON is to be read
80+
* @return the created JSON parser
8081
*/
8182
JsonParser createParser(Reader reader);
8283

@@ -86,6 +87,7 @@ public interface JsonParserFactory {
8687
* as specified in <a href="http://tools.ietf.org/rfc/rfc4627.txt">RFC 4627</a>.
8788
*
8889
* @param in i/o stream from which JSON is to be read
90+
* @return the created JSON parser
8991
* @throws javax.json.JsonException if encoding cannot be determined
9092
* or i/o error (IOException would be cause of JsonException)
9193
*/
@@ -98,20 +100,23 @@ public interface JsonParserFactory {
98100
*
99101
* @param in i/o stream from which JSON is to be read
100102
* @param charset a charset
103+
* @return the created JSON parser
101104
*/
102105
JsonParser createParser(InputStream in, Charset charset);
103106

104107
/**
105108
* Creates a JSON parser from the specified JSON object.
106109
*
107110
* @param obj a JSON object
111+
* @return the created JSON parser
108112
*/
109113
JsonParser createParser(JsonObject obj);
110114

111115
/**
112116
* Creates a JSON parser from the specified JSON array.
113117
*
114118
* @param array a JSON array
119+
* @return the created JSON parser
115120
*/
116121
JsonParser createParser(JsonArray array);
117122

0 commit comments

Comments
 (0)