Skip to content

Commit 0c72820

Browse files
committed
doc: minor javadoc updates
1 parent 6f5cbab commit 0c72820

File tree

3 files changed

+7
-9
lines changed

3 files changed

+7
-9
lines changed

module/jsonurl-core/src/main/java/org/jsonurl/util/PercentCodec.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,7 @@ private PercentCodec() {
5151
}
5252

5353
/**
54-
* Get the next codepoint, percent decoding if necessary. This will
55-
* validate the literal character (not the decoded character) as
56-
* {@code valid[CHAR] & mask}.
54+
* Get the next codepoint, percent decoding if necessary.
5755
* @param text a valid CharIterator
5856
* @return a UNICODE codepoint
5957
*/
@@ -62,10 +60,10 @@ public static int decode(CharIterator text) throws IOException {
6260
}
6361

6462
/**
65-
* Get the next codepoint, percent decoding if necessary. This will
66-
* validate the literal character (not the decoded character) as
67-
* {@code valid[CHAR] & mask}.
63+
* Get the next codepoint, percent decoding if necessary.
6864
* @param text a valid CharIterator
65+
* @param decodePlus if true, decode {@code +} as though it
66+
* was {@code %20}
6967
* @return a UNICODE codepoint
7068
*/
7169
@SuppressWarnings({

module/jsonurl-core/src/main/javadoc/overview.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ <h2>The Streaming API</h2>
2929
<h2><a id="security" href="#security">Security</a></h2>
3030
<p>The parser is designed to parse untrusted input. It supports limits on
3131
the number of parsed values and depth of nested arrays or objects. When the
32-
limit is exceeded a LimitException is thrown. Sane limit values are set by
33-
default.
32+
limit is exceeded a LimitException is thrown. Reasonable limit values are
33+
set by default.
3434

3535
</body>
3636
</html>

src/main/javadoc/overview.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h2><a id="security" href="#security">Artifacts and Packages</a></h2>
2828

2929
<dt>jsonurl-factory</dt>
3030
<dd>Provides the <a href="org/jsonurl/factory/package-summary.html">org.jsonurl.factory</a> package</dd>
31-
<dd>Provides the <a href="org/jsonurl/factory/j2se/package-summary.html">org.jsonurl.j2se</a> package</dd>
31+
<dd>Provides the <a href="org/jsonurl/j2se/package-summary.html">org.jsonurl.j2se</a> package</dd>
3232

3333
<dt>jsonurl-jsonorg</dt>
3434
<dd>Provides the <a href="org/jsonurl/jsonorg/package-summary.html">org.jsonurl.jsonorg</a> package</dd>

0 commit comments

Comments
 (0)